Work easily with data from SESAM Interface Files.
Python package that enables easy extraction of data from SESAM Interface Files.
The following file formats are currently supported:
- Formatted finite element model file (.FEM)
- Formatted interface file (.SIF)
- Unformatted interface file (.SIU)
Install the latest release
pip install freesif
... and import it into a script
from freesif import open_sif
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Install Python version 3.6 or later from either https://www.python.org or https://www.anaconda.com.
At the desired location, run:
git clone https://github.com/agrav/freesif.git
To get the development environment running:
... create an isolated Python environment and activate it,
python -m venv /path/to/new/virtual/environment
/path/to/new/virtual/environment/Scripts/activate
... install the dev dependencies in requirements.txt,
pip install -r requirements.txt
.. and install the package in development mode.
python setup.py develop
You should now be able to import the package in the Python console,
import freesif
help(freesif)
The unit tests are automated using the unittest
and pytest
framework. Run the test by...
pytest --cov=freesif --cov-report term-missing tests/
Build tarball and wheel distributions by:
pip install wheel
python setup.py sdist bdist_wheel
The distribution file names adhere to the PEP 0427
convention {distribution}-{version}(-{build tag})?-{python tag}-{abi tag}-{platform tag}.whl
.
Packaging, unit testing and deployment to PyPi is automated using GitHub Actions.
We apply the "major.minor.micro" versioning scheme defined in PEP 440.
Cut a new version by applying a Git tag like 1.0.1
at the desired commit and then
setuptools_scm takes care of the rest. For the versions
available, see the tags on this repository.
- Audun Gravdal Johansen - agrav
This project is licensed under the MIT License - see the LICENSE file for details.