summaryrefslogtreecommitdiff
path: root/python-fdsreader.spec
diff options
context:
space:
mode:
authorCoprDistGit <infra@openeuler.org>2023-05-30 17:10:30 +0000
committerCoprDistGit <infra@openeuler.org>2023-05-30 17:10:30 +0000
commit85b5df3a647a65ac2b4d5489e5de3f1b1ac320ac (patch)
tree49dc8734843b7b5ea9eff47ddff1285c704a445a /python-fdsreader.spec
parent4c3e1eb47b81460b140c5722b84f3757ea6a82ec (diff)
automatic import of python-fdsreader
Diffstat (limited to 'python-fdsreader.spec')
-rw-r--r--python-fdsreader.spec366
1 files changed, 366 insertions, 0 deletions
diff --git a/python-fdsreader.spec b/python-fdsreader.spec
new file mode 100644
index 0000000..cdc0af6
--- /dev/null
+++ b/python-fdsreader.spec
@@ -0,0 +1,366 @@
+%global _empty_manifest_terminate_build 0
+Name: python-fdsreader
+Version: 1.9.9
+Release: 1
+Summary: Python reader for data generated by FDS.
+License: GNU Lesser General Public License v3 (LGPLv3)
+URL: https://github.com/FireDynamics/fdsreader
+Source0: https://mirrors.nju.edu.cn/pypi/web/packages/1a/b7/81c65de41d7bb31380820584eab6743a0aa5f92c914beb42885960548a02/fdsreader-1.9.9.tar.gz
+BuildArch: noarch
+
+Requires: python3-incremental
+Requires: python3-numpy
+Requires: python3-typing-extensions
+
+%description
+# FDSReader
+> Fast and easy-to-use Python reader for FDS data
+
+[![PyPI version](https://badge.fury.io/py/fdsreader.png)](https://badge.fury.io/py/fdsreader)
+
+
+## Installation
+
+The package is available on PyPI and can be installed using pip:
+```sh
+pip install fdsreader
+```
+_FDS Version 6.7.5 and above are fully supported. Versions below 6.7.5 might work, but are not guaranteed to work._
+
+## Usage example
+
+```python
+import fdsreader as fds
+
+# Creates an instance of a simulation master-class which manages all data for a given simulation
+sim = fds.Simulation("./sample_data")
+
+# Examples of data that can be easily accessed
+print(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.
+
+### Configuration
+The package provides a few configuration options that can be set using the `settings` module.
+```python
+fds.settings.KEY = VALUE
+
+# Example
+fds.settings.DEBUG = True
+```
+
+| KEY | VALUE | Default | Description |
+|----------------|---------|---------|-------------|
+| LAZY_LOAD | boolean | True | Load all data when initially loading the simulation (False) or only when specific data is needed (True). |
+| ENABLE_CACHING | boolean | True | Cache the loaded simulation to reduce startup times when loading the same simulation again. |
+| DEBUG | boolean | False | Crash on non-critical errors with an exception (True) or output non-critical errors as warnings (False). |
+| IGNORE_ERRORS | boolean | False | Ignore any non-critical errors completely. |
+
+
+### Data structure
+![Data structure](https://raw.githubusercontent.com/FireDynamics/fdsreader/master/docs/img/data-structure.svg)
+
+Beware that not all attributes and methods are covered in this diagram. For a complete
+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
+```
+
+### Manual deployment
+It is also possible to deploy to PyPI and Github pages manually using the following steps:
+1. python setup.py sdist bdist_wheel
+2. twine upload dist/*
+3. sphinx-build -b html docs docs/build
+4. cd .. && mkdir gh-pages && cd gh-pages
+5. git init && git remote add origin git@github.com:FireDynamics/fdsreader.git
+6. git fetch --all
+7. git checkout gh-pages
+8. cp -r ../fdsreader/docs/build/* .
+9. git add . && git commit -m "..." && git push origin HEAD:gh-pages
+
+## Meta
+
+* Jan Vogelsang – j.vogelsang@fz-juelich.de
+* Prof. Dr. Lukas Arnold - l.arnold@fz-juelich.de
+
+Distributed under the LGPLv3 (GNU Lesser General Public License v3) license. See ``LICENSE`` for more information.
+
+[https://github.com/FireDynamics/fdsreader](https://github.com/FireDynamics/fdsreader)
+
+## Contributing
+
+1. Fork it (<https://github.com/FireDynamics/fdsreader/fork>)
+2. Create your feature branch (`git checkout -b feature/fooBar`)
+3. Commit your changes (`git commit -am 'Add some fooBar'`)
+4. Push to the branch (`git push origin feature/fooBar`)
+5. Create a new Pull Request
+
+
+
+
+%package -n python3-fdsreader
+Summary: Python reader for data generated by FDS.
+Provides: python-fdsreader
+BuildRequires: python3-devel
+BuildRequires: python3-setuptools
+BuildRequires: python3-pip
+%description -n python3-fdsreader
+# FDSReader
+> Fast and easy-to-use Python reader for FDS data
+
+[![PyPI version](https://badge.fury.io/py/fdsreader.png)](https://badge.fury.io/py/fdsreader)
+
+
+## Installation
+
+The package is available on PyPI and can be installed using pip:
+```sh
+pip install fdsreader
+```
+_FDS Version 6.7.5 and above are fully supported. Versions below 6.7.5 might work, but are not guaranteed to work._
+
+## Usage example
+
+```python
+import fdsreader as fds
+
+# Creates an instance of a simulation master-class which manages all data for a given simulation
+sim = fds.Simulation("./sample_data")
+
+# Examples of data that can be easily accessed
+print(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.
+
+### Configuration
+The package provides a few configuration options that can be set using the `settings` module.
+```python
+fds.settings.KEY = VALUE
+
+# Example
+fds.settings.DEBUG = True
+```
+
+| KEY | VALUE | Default | Description |
+|----------------|---------|---------|-------------|
+| LAZY_LOAD | boolean | True | Load all data when initially loading the simulation (False) or only when specific data is needed (True). |
+| ENABLE_CACHING | boolean | True | Cache the loaded simulation to reduce startup times when loading the same simulation again. |
+| DEBUG | boolean | False | Crash on non-critical errors with an exception (True) or output non-critical errors as warnings (False). |
+| IGNORE_ERRORS | boolean | False | Ignore any non-critical errors completely. |
+
+
+### Data structure
+![Data structure](https://raw.githubusercontent.com/FireDynamics/fdsreader/master/docs/img/data-structure.svg)
+
+Beware that not all attributes and methods are covered in this diagram. For a complete
+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
+```
+
+### Manual deployment
+It is also possible to deploy to PyPI and Github pages manually using the following steps:
+1. python setup.py sdist bdist_wheel
+2. twine upload dist/*
+3. sphinx-build -b html docs docs/build
+4. cd .. && mkdir gh-pages && cd gh-pages
+5. git init && git remote add origin git@github.com:FireDynamics/fdsreader.git
+6. git fetch --all
+7. git checkout gh-pages
+8. cp -r ../fdsreader/docs/build/* .
+9. git add . && git commit -m "..." && git push origin HEAD:gh-pages
+
+## Meta
+
+* Jan Vogelsang – j.vogelsang@fz-juelich.de
+* Prof. Dr. Lukas Arnold - l.arnold@fz-juelich.de
+
+Distributed under the LGPLv3 (GNU Lesser General Public License v3) license. See ``LICENSE`` for more information.
+
+[https://github.com/FireDynamics/fdsreader](https://github.com/FireDynamics/fdsreader)
+
+## Contributing
+
+1. Fork it (<https://github.com/FireDynamics/fdsreader/fork>)
+2. Create your feature branch (`git checkout -b feature/fooBar`)
+3. Commit your changes (`git commit -am 'Add some fooBar'`)
+4. Push to the branch (`git push origin feature/fooBar`)
+5. Create a new Pull Request
+
+
+
+
+%package help
+Summary: Development documents and examples for fdsreader
+Provides: python3-fdsreader-doc
+%description help
+# FDSReader
+> Fast and easy-to-use Python reader for FDS data
+
+[![PyPI version](https://badge.fury.io/py/fdsreader.png)](https://badge.fury.io/py/fdsreader)
+
+
+## Installation
+
+The package is available on PyPI and can be installed using pip:
+```sh
+pip install fdsreader
+```
+_FDS Version 6.7.5 and above are fully supported. Versions below 6.7.5 might work, but are not guaranteed to work._
+
+## Usage example
+
+```python
+import fdsreader as fds
+
+# Creates an instance of a simulation master-class which manages all data for a given simulation
+sim = fds.Simulation("./sample_data")
+
+# Examples of data that can be easily accessed
+print(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.
+
+### Configuration
+The package provides a few configuration options that can be set using the `settings` module.
+```python
+fds.settings.KEY = VALUE
+
+# Example
+fds.settings.DEBUG = True
+```
+
+| KEY | VALUE | Default | Description |
+|----------------|---------|---------|-------------|
+| LAZY_LOAD | boolean | True | Load all data when initially loading the simulation (False) or only when specific data is needed (True). |
+| ENABLE_CACHING | boolean | True | Cache the loaded simulation to reduce startup times when loading the same simulation again. |
+| DEBUG | boolean | False | Crash on non-critical errors with an exception (True) or output non-critical errors as warnings (False). |
+| IGNORE_ERRORS | boolean | False | Ignore any non-critical errors completely. |
+
+
+### Data structure
+![Data structure](https://raw.githubusercontent.com/FireDynamics/fdsreader/master/docs/img/data-structure.svg)
+
+Beware that not all attributes and methods are covered in this diagram. For a complete
+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
+```
+
+### Manual deployment
+It is also possible to deploy to PyPI and Github pages manually using the following steps:
+1. python setup.py sdist bdist_wheel
+2. twine upload dist/*
+3. sphinx-build -b html docs docs/build
+4. cd .. && mkdir gh-pages && cd gh-pages
+5. git init && git remote add origin git@github.com:FireDynamics/fdsreader.git
+6. git fetch --all
+7. git checkout gh-pages
+8. cp -r ../fdsreader/docs/build/* .
+9. git add . && git commit -m "..." && git push origin HEAD:gh-pages
+
+## Meta
+
+* Jan Vogelsang – j.vogelsang@fz-juelich.de
+* Prof. Dr. Lukas Arnold - l.arnold@fz-juelich.de
+
+Distributed under the LGPLv3 (GNU Lesser General Public License v3) license. See ``LICENSE`` for more information.
+
+[https://github.com/FireDynamics/fdsreader](https://github.com/FireDynamics/fdsreader)
+
+## Contributing
+
+1. Fork it (<https://github.com/FireDynamics/fdsreader/fork>)
+2. Create your feature branch (`git checkout -b feature/fooBar`)
+3. Commit your changes (`git commit -am 'Add some fooBar'`)
+4. Push to the branch (`git push origin feature/fooBar`)
+5. Create a new Pull Request
+
+
+
+
+%prep
+%autosetup -n fdsreader-1.9.9
+
+%build
+%py3_build
+
+%install
+%py3_install
+install -d -m755 %{buildroot}/%{_pkgdocdir}
+if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
+if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
+if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
+if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
+pushd %{buildroot}
+if [ -d usr/lib ]; then
+ find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/lib64 ]; then
+ find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/bin ]; then
+ find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/sbin ]; then
+ find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+touch doclist.lst
+if [ -d usr/share/man ]; then
+ find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
+fi
+popd
+mv %{buildroot}/filelist.lst .
+mv %{buildroot}/doclist.lst .
+
+%files -n python3-fdsreader -f filelist.lst
+%dir %{python3_sitelib}/*
+
+%files help -f doclist.lst
+%{_docdir}/*
+
+%changelog
+* Tue May 30 2023 Python_Bot <Python_Bot@openeuler.org> - 1.9.9-1
+- Package Spec generated