This repository serves as a minimal example on how to structure you python project.
This project requires python >= 3.5.
You can perform a user-specific installation by running
$ python -m pip install .
from the root of the project. We strongly advise an installation in a virtual environment. You can create and activate one by executing the following two commands from the root of the project
$ python -m venv venv
$ . venv/bin/activate
and then performing the installation as usual by running
(venv) $ python -m pip install .
If you plan to extend the code, then you should perform an editable installation with
(venv) $ python -m pip install -e .
You can run the unit-tests by executing
$ python -m unittest
from the root of the project. The tests include some standard problems of pulse propagation in nonlinear media. During the tests an interactive plotter demonstrating the integration results will be shown. Unfortunately, at the moment it is not possible to disable it, so running tests in a headless setup is not straightforward.
The documentation is written with sphinx. You can build it by running
$ cd doc && make html
from the root of the project. The entry point for the documentation will be placed in doc/_build/html/index.html which you can open with a browser of your choice.
- .gitignore -- how to ignore files in git. Github has some pretty good defaults when creating the repository.
- Markdown -- how to use Markdown format to write
README.md. - Packaging tutorial -- an official tutorial from Python Packaging Authority.