Documentation: Installation

[hayesall]

Installation instructions should be included in the main README and associated documentation.

Recommendation:

• Command for installing from source on GitHub (e.g. clone and pip install -e .)
• Command for installing from PyPi (https://pypi.org/project/nnde/)

[rweigel]

It is standard to include dependencies in setup.py. Without it, the user would need to search for all of the import statements to determine dependencies.

[rweigel]

Test by creating a virtual environment and executing pip install nnde followed by execution of a test or demo. I thought that I did this when testing but clearly I missed it.

[rweigel]

I suggest adding the following section to README.md

Installation

To install the library, use

git clone https://github.com/elwinter/nnde.git
cd nnde; pip install -e .

or

pip install nnde

The demos are stored in a separate repository. To use them, execute

git clone https://github.com/elwinter/nnde_demos
cd nnde_demos
python lagaris01_demo.py
python nnpde2diff_demo.py

[hayesall]

Good recommendation @rweigel. #4 also includes the point for adding all requirements under install_requires in setup.py.

[elwinter]

Instructions for installing from PyPI using pip, and by cloning the GitHub repository, have been added to the top-level README.md.