Document the basics of running pipeline as local demo

ssec-jhu / bluephos

automated computational tool streamlining the development and analysis of blue phosphorescent materials

BSD 3-Clause "New" or "Revised" License

1 stars 1 forks source link

Document the basics of running pipeline as local demo #39

Closed amitschang closed 6 months ago

amitschang commented 7 months ago

We should get enough instructions in the readme to describe a bit about the code and how it works, and then enough commands to copy-paste to run in a local environment, e.g. tox -e test exec -- ... and the expected inputs etc.

This should be done prior to making repo public