Commit 15ada855 authored by Daniel Boeckenhoff's avatar Daniel Boeckenhoff
Browse files

README installation instructions and Developers tools

parent a5e49fb1
# Installation
From user side, we recommend the installation via pypi:
## Requirements
* python versions >=2.7 or >=3.0
## PyPI
From user side, we recommend the installation via PyPI:
pip install tfields
pip install w7x
In this process all dependencies are resolved automatically.
# Testing:
In the tfields directory, run
## Git
If you want to keep on track very tightly to the project and or want to support development, clone the git to your <favourite_directory> and set the $PYTHONPATH variable.
python tfields test
cd favourite_directory
git clone # clone the repository
git submodule update --init --recursive # also clone all submodules (developer tools only. The code can run without this step.)
echo 'export PYTHONPATH=$PYTHONPATH:</path/to/my/facvourite_directory/w7x>' >> ~/.bashrc # permanently set the $PYTHONPATH variable
source ~/.bashrc # make the PYTHONPATH change active
# Developers only:
Clone this project with git
To set up the shared git hooks, run
## Testing and Coverage:
This code is tested. New versions are only published, if the code coverage lies above 80% with no failing unit test.
If you want to check any of this, you have to download the code via git (see above)
In the tfields directory, run
make init
make test
To check the coverage, run
make coverage
To check the coverage, we prefere the 'coverage' tool
Use it in the tfields directory like so:
## Git Hooks
To set up the shared git hooks, run
coverage run tfields test
make init
## Publishing to PyPI
Publishing new versions of the code:
*Change the version number in tfields/
*Then run
make coverage
make publish
......@@ -17,7 +17,7 @@ __all__ = [
__version__ = '0.1.1'
__version__ = '0.1.2'
__title__ = os.path.basename(os.path.abspath('.'))
__summary__ = "numpy + sympy implementation of tensor fields with attached coordinate systems"
__keywords__ = "tensors coordinate system trafo sympy numpy"
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment