# FDSReader
> Fast and easy-to-use Python reader for FDS data
[![Build Status](https://travis-ci.com/FireDynamics/fdsreader.svg?branch=master)](https://travis-ci.com/FireDynamics/fdsreader)
[![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
```
## 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.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 hide non-critical errors (False). |
### 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/)
## 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
没有合适的资源?快使用搜索试试~ 我知道了~
温馨提示
共49个文件
py:38个
txt:5个
pkg-info:2个
资源分类:Python库 所属语言:Python 资源全名:fdsreader-1.1.0.tar.gz 资源来源:官方 安装方法:https://lanzao.blog.csdn.net/article/details/101784059
资源推荐
资源详情
资源评论
收起资源包目录
fdsreader-1.1.0.tar.gz (49个子文件)
fdsreader-1.1.0
MANIFEST.in 42B
PKG-INFO 4KB
fdsreader.egg-info
PKG-INFO 4KB
requires.txt 49B
SOURCES.txt 1KB
top_level.txt 10B
dependency_links.txt 1B
LICENSE 34KB
setup.cfg 38B
requirements.txt 2KB
setup.py 988B
README.md 3KB
fdsreader
pl3d
Plot3DCollection.py 1KB
pl3d.py 6KB
__init__.py 73B
simulation.py 40KB
slcf
slice.py 19KB
SliceCollection.py 2KB
__init__.py 71B
part
__init__.py 83B
ParticleCollection.py 5KB
particle.py 4KB
smoke3d
__init__.py 79B
Smoke3DCollection.py 1KB
smoke3d.py 8KB
__init__.py 132B
settings.py 544B
geom
__init__.py 97B
geometry.py 11KB
GeometryCollection.py 1KB
_version.py 265B
utils
fds_classes
MeshCollection.py 713B
__init__.py 1B
ventilation.py 3KB
surface.py 1KB
mesh.py 5KB
dimension.py 2KB
misc.py 814B
__init__.py 323B
extent.py 3KB
fortran_data.py 3KB
data.py 4KB
isof
IsosurfaceCollection.py 1KB
__init__.py 91B
isosurface.py 15KB
bndf
ObstructionCollection.py 2KB
utils.py 1KB
obstruction.py 14KB
__init__.py 128B
共 49 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功