Skip to content

Commit e74ddc2

Browse files
authored
Merge pull request #863 from goelakash/joss-docs-python-version
[Docs] Add python version badge to README
2 parents d8ad926 + e519cc2 commit e74ddc2

File tree

4 files changed

+5
-4
lines changed

4 files changed

+5
-4
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![documentation](https://bim2sim.github.io/bim2sim/development/docs/doc.svg)](https://bim2sim.github.io/bim2sim/development/docs/index.html)
44
[![coverage (W/O Plugins)](https://bim2sim.github.io/bim2sim/development/coverage/badge.svg)](https://bim2sim.github.io/bim2sim/development/coverage)
55
[![License: LGPL v3](https://img.shields.io/badge/License-LGPL_v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
6+
![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11-blue)
67

78
bim2sim is a library to create simulation models for different purposes based on BIM models in the IFC format. The project is based on a base code that provides the possiblity to map the IFC data into a uniform meta strucuture. This structure can then be used to create simulation models for different purposes which is done by plugins. The corresponding project BIM2SIM (see founding section below) adressed the following four domains:
89

@@ -14,7 +15,7 @@ The focus of the currently released tool is on BPS and HVAC but we already provi
1415
![Toolchain](docs/source/img/static/bim2sim_framework_overview.png)
1516

1617
## Installation and Usage
17-
You can find detailed documentation and description how to install and to use in our [documentation](https://bim2sim.github.io/bim2sim//development/docs/index.html). We recommend reading at least:
18+
bim2sim requires Python >= 3.10 and < 3.12. You can find detailed documentation and description how to install and to use in our [documentation](https://bim2sim.github.io/bim2sim//development/docs/index.html). We recommend reading at least:
1819
* [Big Picture](https://bim2sim.github.io/bim2sim//development/docs/big-picture.html) to understand the concepts of bim2sim
1920
* [PluginTemplate - How to install?](https://bim2sim.github.io/bim2sim//development/docs/user-guide/PluginTemplate.html#how-to-install) to understand how to install the Base of the framework.
2021

docs/source/user-guide/PluginComfort.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Please follow the installation instructions of the [PluginEnergyPlus
1717
### Step by step
1818

1919
### Trouble Shooting
20-
For python > 3.9: make sure that the correct geomeppy is installed (using requirements.txt in the plugin): in this fork of geomeppy, we fixed the imports working from python >= 3.10: https://github.com/BIM2SIM/geomeppy/tree/fix_dependencies
20+
For Python >=3.10: make sure that the correct geomeppy is installed (using requirements.txt in the plugin): in this fork of geomeppy, we fixed the imports for Python >=3.10: https://github.com/BIM2SIM/geomeppy/tree/fix_dependencies
2121

2222
### Test install
2323

docs/source/user-guide/PluginEnergyPlus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ pip install -e '.[PluginEnergyPlus]'
1313
The [bim2sim core installation](coreInstalltion) needs to be done before.
1414

1515
### Trouble Shooting
16-
For python > 3.9: make sure that the correct geomeppy is installed (using requirements.txt in the plugin): in this fork of geomeppy, we fixed the imports working from python >= 3.10: https://github.com/BIM2SIM/geomeppy/tree/fix_dependencies
16+
For Python >=3.10: make sure that the correct geomeppy is installed (using requirements.txt in the plugin): in this fork of geomeppy, we fixed the imports for Python >=3.10: https://github.com/BIM2SIM/geomeppy/tree/fix_dependencies
1717

1818
### Test install
1919

docs/source/user-guide/PluginTemplate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ version of [mamba](https://github.com/mamba-org/mamba)) is used.
3535

3636
We will guide you through the process now.
3737
```shell
38-
# create fresh python environment with conda (python 3.10 to 3.11 are supported currently)
38+
# create fresh python environment with conda (Python >=3.10, <3.12 is required)
3939
micromamba create -n bim2sim python=3.11 -c conda-forge
4040
# activate your environment
4141
micromamba activate bim2sim

0 commit comments

Comments
 (0)