# FREESIF
Work easily with data from SESAM Interface Files.
## General
### About
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)
### Getting started
Install the latest release
```console
pip install freesif
```
... and import it into a script
```python
from freesif import open_sif
```
### Resources
* [**Source**](https://github.com/agrav/freesif)
* [**Issues**](https://github.com/agrav/freesif/issues)
* [**Changelog**](https://github.com/agrav/freesif/releases)
* [**Documentation**](https://github.com/agrav/freesif/blob/master/README.md)
* [**Download**](https://pypi.org/project/freesif/)
## Contribute
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.
### Prerequisites
Install Python version 3.6 or later from either https://www.python.org or https://www.anaconda.com.
### Clone the source code repository
At the desired location, run:
```git clone https://github.com/agrav/freesif.git```
### Installing
To get the development environment running:
... create an isolated Python environment and activate it,
```console
python -m venv /path/to/new/virtual/environment
/path/to/new/virtual/environment/Scripts/activate
```
... install the dev dependencies in [requirements.txt](requirements.txt),
```console
pip install -r requirements.txt
```
.. and install the package in development mode.
```console
python setup.py develop
```
You should now be able to import the package in the Python console,
```python
import freesif
help(freesif)
```
### Running the tests
The unit tests are automated using the `unittest` and `pytest` framework. Run the test by...
```console
pytest --cov=freesif --cov-report term-missing tests/
```
### Building the package
Build tarball and wheel distributions by:
```console
pip install wheel
python setup.py sdist bdist_wheel
```
The distribution file names adhere to the [PEP 0427](https://www.python.org/dev/peps/pep-0427/#file-name-convention)
convention `{distribution}-{version}(-{build tag})?-{python tag}-{abi tag}-{platform tag}.whl`.
<!---
### Building the documentation
The html documentation is build using [Sphinx](http://www.sphinx-doc.org/en/master)
```console
sphinx-build -b html docs\source docs\_build
```
--->
### Deployment
Packaging, unit testing and deployment to [PyPi](https://pypi.org) is automated using GitHub Actions.
### Versioning
We apply the "major.minor.micro" versioning scheme defined in [PEP 440](https://www.python.org/dev/peps/pep-0440/).
Cut a new version by applying a Git tag like `1.0.1` at the desired commit and then
[setuptools_scm](https://github.com/pypa/setuptools_scm/#setup-py-usage) takes care of the rest. For the versions
available, see the [tags on this repository](https://github.com/agrav/freesif/tags).
## Authors
* **Audun Gravdal Johansen** - [agrav](https://github.com/agrav)
## Maintainers
* **Audun Gravdal Johansen** - [agrav](https://github.com/agrav)
* **Per Voie** - [tovop](https://github.com/tovop)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/agrav/freesif",
"name": "freesif",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "sesam, structural, hydrodynamic",
"author": "Audun Gravdal Johansen",
"author_email": "audun.gravdal.johansen@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/92/ef/d5ffbda15bee4863a4e55259300a7254bed23d302588453d4e3c57c5d0ba/freesif-0.2.0.tar.gz",
"platform": null,
"description": "# FREESIF\n\nWork easily with data from SESAM Interface Files.\n\n## General\n\n### About\n\nPython package that enables easy extraction of data from SESAM Interface Files.\n\nThe following file formats are currently supported:\n\n- Formatted finite element model file (.FEM)\n- Formatted interface file (.SIF)\n- Unformatted interface file (.SIU)\n\n### Getting started\n\nInstall the latest release\n\n```console\npip install freesif\n```\n\n... and import it into a script\n\n```python\nfrom freesif import open_sif\n```\n\n### Resources\n\n* [**Source**](https://github.com/agrav/freesif)\n* [**Issues**](https://github.com/agrav/freesif/issues)\n* [**Changelog**](https://github.com/agrav/freesif/releases)\n* [**Documentation**](https://github.com/agrav/freesif/blob/master/README.md)\n* [**Download**](https://pypi.org/project/freesif/)\n\n## Contribute\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing\npurposes. See deployment for notes on how to deploy the project on a live system.\n\n### Prerequisites\n\nInstall Python version 3.6 or later from either https://www.python.org or https://www.anaconda.com.\n\n### Clone the source code repository\n\nAt the desired location, run:\n\n```git clone https://github.com/agrav/freesif.git```\n\n### Installing\n\nTo get the development environment running:\n\n... create an isolated Python environment and activate it,\n\n```console\npython -m venv /path/to/new/virtual/environment\n\n/path/to/new/virtual/environment/Scripts/activate\n```\n\n... install the dev dependencies in [requirements.txt](requirements.txt),\n\n```console\npip install -r requirements.txt\n```\n\n.. and install the package in development mode.\n\n```console\npython setup.py develop\n```\n\nYou should now be able to import the package in the Python console,\n\n```python\nimport freesif\nhelp(freesif)\n```\n\n### Running the tests\n\nThe unit tests are automated using the `unittest` and `pytest` framework. Run the test by...\n\n```console\npytest --cov=freesif --cov-report term-missing tests/\n```\n\n### Building the package\n\nBuild tarball and wheel distributions by:\n\n```console\npip install wheel\npython setup.py sdist bdist_wheel\n```\n\nThe distribution file names adhere to the [PEP 0427](https://www.python.org/dev/peps/pep-0427/#file-name-convention)\nconvention `{distribution}-{version}(-{build tag})?-{python tag}-{abi tag}-{platform tag}.whl`.\n\n<!---\n### Building the documentation\n\nThe html documentation is build using [Sphinx](http://www.sphinx-doc.org/en/master)\n\n```console\nsphinx-build -b html docs\\source docs\\_build\n```\n--->\n\n### Deployment\nPackaging, unit testing and deployment to [PyPi](https://pypi.org) is automated using GitHub Actions.\n\n### Versioning\n\nWe apply the \"major.minor.micro\" versioning scheme defined in [PEP 440](https://www.python.org/dev/peps/pep-0440/).\n\nCut a new version by applying a Git tag like `1.0.1` at the desired commit and then\n[setuptools_scm](https://github.com/pypa/setuptools_scm/#setup-py-usage) takes care of the rest. For the versions\navailable, see the [tags on this repository](https://github.com/agrav/freesif/tags).\n\n## Authors\n\n* **Audun Gravdal Johansen** - [agrav](https://github.com/agrav)\n\n## Maintainers\n\n* **Audun Gravdal Johansen** - [agrav](https://github.com/agrav)\n* **Per Voie** - [tovop](https://github.com/tovop)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Get data from Sesam Interface Files",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/agrav/freesif",
"Repository": "https://github.com/agrav/freesif",
"issues": "https://github.com/agrav/freesif/issues"
},
"split_keywords": [
"sesam",
" structural",
" hydrodynamic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "46876eac6d784fad6dd6c07244b963a3deaf2b25261056bd40b5c088164d963c",
"md5": "583acc0580d7d57cda390229cd25efa5",
"sha256": "5e3f74776935c382f0f5acdfa36fe91e2a1491ec6b22c5ac37be59a10b177eed"
},
"downloads": -1,
"filename": "freesif-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "583acc0580d7d57cda390229cd25efa5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 52329,
"upload_time": "2024-12-19T08:29:27",
"upload_time_iso_8601": "2024-12-19T08:29:27.906767Z",
"url": "https://files.pythonhosted.org/packages/46/87/6eac6d784fad6dd6c07244b963a3deaf2b25261056bd40b5c088164d963c/freesif-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "92efd5ffbda15bee4863a4e55259300a7254bed23d302588453d4e3c57c5d0ba",
"md5": "09429b1ef148547c2f42e5f64248d1ff",
"sha256": "06450f5d14427ada108748133773b1c779a10b80b6c15a21cc081f4ccf20ee13"
},
"downloads": -1,
"filename": "freesif-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "09429b1ef148547c2f42e5f64248d1ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 47190,
"upload_time": "2024-12-19T08:29:29",
"upload_time_iso_8601": "2024-12-19T08:29:29.446222Z",
"url": "https://files.pythonhosted.org/packages/92/ef/d5ffbda15bee4863a4e55259300a7254bed23d302588453d4e3c57c5d0ba/freesif-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 08:29:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "agrav",
"github_project": "freesif",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "freesif"
}
JSON
