https://github.com/vanderhe/fortnet-python
Python Tools for the Fortnet Software Package
https://github.com/vanderhe/fortnet-python
fortnet neural-networks python scientific-computing tools
Last synced: 5 days ago
JSON representation
Python Tools for the Fortnet Software Package
- Host: GitHub
- URL: https://github.com/vanderhe/fortnet-python
- Owner: vanderhe
- License: bsd-2-clause
- Created: 2021-10-20T11:50:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-22T09:21:40.000Z (over 1 year ago)
- Last Synced: 2026-04-28T05:18:07.550Z (about 2 months ago)
- Topics: fortnet, neural-networks, python, scientific-computing, tools
- Language: Python
- Homepage: https://github.com/vanderhe/fortnet
- Size: 148 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
*************************************************************
fortnet-python: Python Tools for the Fortnet Software Package
*************************************************************
|license|
|latest version|
|doi|
|issues|
fortnet-python provides tools to generate compatible datasets as well as extract
results obtained by the neural network implementation
`Fortnet `_.
|logo|
Installation
============
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.
Via the Python Package Index
----------------------------
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
Locally from Source
-------------------
Alternatively, you can install it locally from source, i.e. from the root folder
of the project::
python -m pip install .
Testing
=======
The regression testsuite utilizes the `pytest` framework and may be installed
and executed by
::
pip install .[test]
python -m pytest --basetemp=Testing
Documentation
=============
|docs status|
Consult following resources for documentation:
* `Step-by-step instructions with selected examples (Fortnet Recipes)
`_
Contributing
============
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!
License
=======
fortnet-python is released under the BSD 2-clause license. See the included
`LICENSE `_ file for the detailed licensing conditions.
.. |logo| image:: ./utils/art/logo.svg
:alt: Fortnet logo
:width: 90
:target: https://github.com/vanderhe/fortnet/
.. |license| image:: https://img.shields.io/github/license/vanderhe/fortnet-python
:alt: BSD-2-Clause
:scale: 100%
:target: https://opensource.org/licenses/BSD-2-Clause
.. |latest version| image:: https://img.shields.io/github/v/release/vanderhe/fortnet-python
:target: https://github.com/vanderhe/fortnet-python/releases/latest
.. |doi| image:: https://zenodo.org/badge/356394988.svg
:target: https://zenodo.org/badge/latestdoi/356394988
.. |docs status| image:: https://readthedocs.org/projects/fortnet/badge/?version=latest
:alt: Documentation Status
:scale: 100%
:target: https://fortnet-python.readthedocs.io/en/latest/
.. |issues| image:: https://img.shields.io/github/issues/vanderhe/fortnet-python.svg
:target: https://github.com/vanderhe/fortnet-python/issues/
.. |build status| image:: https://img.shields.io/github/workflow/status/vanderhe/fortnet-python/CI
:target: https://github.com/vanderhe/fortnet-python/actions/