fdsreader 1.11.4__tar.gz → 1.11.6__tar.gz

{fdsreader-1.11.4 → fdsreader-1.11.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fdsreader
-Version: 1.11.4
+Version: 1.11.6
 Summary: Python reader for data generated by FDS.
 Author-email: "FZJ IAS-7 (Jan Vogelsang, Prof. Dr. Lukas Arnold, Tristan Hehnen)" <j.vogelsang@fz-juelich.de>
 License:    GNU GENERAL PUBLIC LICENSE
@@ -744,18 +744,21 @@ documentation of all classes check the API Documentation below.
 ## API Documentation
 [https://firedynamics.github.io/fdsreader/](https://firedynamics.github.io/fdsreader/)
 
-## Deployment
-As the fdsreader has come a long way and the free capabilities of Travis CI have been used up, we now moved to manual CI/CD using a local docker container.  
-First, the Dockerfile has to be modified to make authentication to GitHub and PyPI possible from within the container.
-To do so generate these two tokens:  
-PyPI: https://pypi.org/manage/account/token/  
-GitHub: https://github.com/settings/tokens/new (set the repo_deployment and public_repo scopes)  
-Now add these Tokens in the Dockerfile. To now deploy the fdsreader to PyPI and update the Github Pages (Documentation), run the following commands after pushing your changes to the FDSReader to GitHub (apart from the Dockerfile).
-```bash
-cd $REPO_ROOT_DIR
-docker build . -t fdsreader-ci  # Only needed the very first time
-docker run --rm fdsreader-ci
-```
+Deployment now follows the [Python Packaging User Guide's recommendation](https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/).
+
+With this setup, deployments to both TestPyPI and PyPI are automated. Every push to GitHub triggers a deployment to TestPyPI, simplifying the testing of new changes and validating the CI pipeline. Therefore, it is necessary to set the package version to `.dev` to avoid blocking version numbers.
+
+### Deploying an Untested/Unstable Version:
+1. Execute: `python3 -m incremental.update fdsreader --dev`
+2. Push changes to GitHub.
+
+If you are sure your changes are stable push a GitHub Tag to perform deployment 
+to PyPI and to pack a GitHub Release
+Deploying a tested/stable version:
+1. set the new version with `python3 -m incremental.update fdsreader --newversion=<version>`
+2. Push changes to GitHub
+3. Push Tag to GitHub with git push origin tag <version>
+
 
 ### Manual deployment
 It is also possible to deploy to PyPI and Github pages manually using the following steps:

{fdsreader-1.11.4 → fdsreader-1.11.6}/README.md

@@ -52,18 +52,21 @@ documentation of all classes check the API Documentation below.
 ## API Documentation
 [https://firedynamics.github.io/fdsreader/](https://firedynamics.github.io/fdsreader/)
 
-## Deployment
-As the fdsreader has come a long way and the free capabilities of Travis CI have been used up, we now moved to manual CI/CD using a local docker container.  
-First, the Dockerfile has to be modified to make authentication to GitHub and PyPI possible from within the container.
-To do so generate these two tokens:  
-PyPI: https://pypi.org/manage/account/token/  
-GitHub: https://github.com/settings/tokens/new (set the repo_deployment and public_repo scopes)  
-Now add these Tokens in the Dockerfile. To now deploy the fdsreader to PyPI and update the Github Pages (Documentation), run the following commands after pushing your changes to the FDSReader to GitHub (apart from the Dockerfile).
-```bash
-cd $REPO_ROOT_DIR
-docker build . -t fdsreader-ci  # Only needed the very first time
-docker run --rm fdsreader-ci
-```
+Deployment now follows the [Python Packaging User Guide's recommendation](https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/).
+
+With this setup, deployments to both TestPyPI and PyPI are automated. Every push to GitHub triggers a deployment to TestPyPI, simplifying the testing of new changes and validating the CI pipeline. Therefore, it is necessary to set the package version to `.dev` to avoid blocking version numbers.
+
+### Deploying an Untested/Unstable Version:
+1. Execute: `python3 -m incremental.update fdsreader --dev`
+2. Push changes to GitHub.
+
+If you are sure your changes are stable push a GitHub Tag to perform deployment 
+to PyPI and to pack a GitHub Release
+Deploying a tested/stable version:
+1. set the new version with `python3 -m incremental.update fdsreader --newversion=<version>`
+2. Push changes to GitHub
+3. Push Tag to GitHub with git push origin tag <version>
+
 
 ### Manual deployment
 It is also possible to deploy to PyPI and Github pages manually using the following steps:

fdsreader-1.11.6/fdsreader/__init__.py

@@ -0,0 +1,6 @@
+from . import _version
+__version__ = str(_version.__version__.public())
+
+from .simulation import Simulation
+
+from . import settings

fdsreader-1.11.6/fdsreader/_version.py

@@ -0,0 +1,11 @@
+"""
+Provides fdsreader version information.
+"""
+
+# This file is auto-generated! Do not edit!
+# Use `python -m incremental.update fdsreader` to change this file.
+
+from incremental import Version
+
+__version__ = Version("fdsreader", 1, 11, 6)
+__all__ = ["__version__"]

fdsreader-1.11.6/fdsreader/settings.py

@@ -0,0 +1,15 @@
+LAZY_LOAD = True
+
+ENABLE_CACHING = True
+
+DEBUG = False
+
+IGNORE_ERRORS = False
+
+# As the binary representation of raw data is compiler dependent, this information must be provided
+# by the user
+FORTRAN_DATA_TYPE_INTEGER = "<i4"  # <i4 -> 4-byte integer (little-endian)
+FORTRAN_DATA_TYPE_UINT8 = "<u1"  # <u1 -> 1-byte unsigned integer (little-endian)
+FORTRAN_DATA_TYPE_FLOAT = "<f4"  # <f4 -> 4-byte floating point (little-endian)
+FORTRAN_DATA_TYPE_CHAR = "S"  # S -> 1-byte char
+FORTRAN_BACKWARD = True  # Sets weather the blocks are ended with the size of the block