fortnet-python provides tools to generate compatible datasets as well as extract results obtained by the neural network implementation Fortnet.
Please note, that this package has been tested for Python 3.X support. Its usage additionally requires
- numerical Python (numpy)
- pythonic HDF5 (h5py)
- Atomic Simulation Environment (ase)
as well as the pytest framework in order to run the regression tests.
First, make sure you have an up-to-date version of pip installed:
python -m pip install --upgrade pip
The package can be downloaded and installed via pip into the active Python interpreter (preferably using a virtual python environment) by
pip install fortnet-python
or into the user space issueing:
pip install --user fortnet-python
Alternatively, you can install it locally from source, i.e. from the root folder of the project:
python -m pip install .
The regression testsuite utilizes the pytest framework and may be executed by
python -m pytest --basetemp=Testing
Consult following resources for documentation:
New features, bug fixes, documentation, tutorial examples and code testing is welcome during the ongoing fortnet-python development!
The project is hosted on github. Please check CONTRIBUTING.rst for guide lines.
I am looking forward to your pull request!
fortnet-python is released under the BSD 2-clause license. See the included LICENSE file for the detailed licensing conditions.