Package: fdsreader
FDSReaderFast and easy-to-use Python reader for FDS dataInstallationThe package is available on PyPI and can be installed using pip:pipinstallfdsreaderFDS Version 6.7.5 and above are fully supported. Versions below 6.7.5 might work, but are not guaranteed to work.Usage exampleimportfdsreaderasfds# Creates an instance of a simulation master-class which manages all data for a given simulationsim=fds.Simulation("./sample_data")# Examples of data that can be easily accessedprint(sim.meshes,sim.surfaces,sim.slices,sim.data_3d,sim.smoke_3d,sim.isosurfaces,sim.particles,sim.obstructions)More advanced examples can be found in the respective data type directories inside of the examples directory.ConfigurationThe package provides a few configuration options that can be set using thesettingsmodule.fds.settings.KEY=VALUE# Examplefds.settings.DEBUG=TrueKEYVALUEDefaultDescriptionLAZY_LOADbooleanTrueLoad all data when initially loading the simulation (False) or only when specific data is needed (True).ENABLE_CACHINGbooleanTrueCache the loaded simulation to reduce startup times when loading the same simulation again.DEBUGbooleanFalseCrash on non-critical errors with an exception (True) or output non-critical errors as warnings (False).IGNORE_ERRORSbooleanFalseIgnore any non-critical errors completely.Data structureBeware that not all attributes and methods are covered in this diagram. For a completedocumentation of all classes check the API Documentation below.API Documentationhttps://firedynamics.github.io/fdsreader/DeploymentAs 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).cd$REPO_ROOT_DIRdockerbuild.-tfdsreader-ci# Only needed the very first timedockerrun--rmfdsreader-ciManual deploymentIt is also possible to deploy to PyPI and Github pages manually using the following steps:python setup.py sdist bdist_wheeltwine upload dist/*sphinx-build -b html docs docs/buildcd .. && mkdir gh-pages && cd gh-pagesgit init && git remote add origingit@github.com:FireDynamics/fdsreader.gitgit fetch --allgit checkout gh-pagescp -r ../fdsreader/docs/build/* .git add . && git commit -m "..." && git push origin HEAD:gh-pagesMetaJan Vogelsang –j.vogelsang@fz-juelich.deProf. Dr. Lukas Arnold -l.arnold@fz-juelich.deDistributed under the LGPLv3 (GNU Lesser General Public License v3) license. SeeLICENSEfor more information.https://github.com/FireDynamics/fdsreaderContributingFork it (https://github.com/FireDynamics/fdsreader/fork)Create your feature branch (git checkout -b feature/fooBar)Commit your changes (git commit -am 'Add some fooBar')Push to the branch (git push origin feature/fooBar)Create a new Pull Request