Skip to content

Commit a83c7ef

Browse files
committed
Readme update
1 parent c1c82aa commit a83c7ef

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,23 @@
66
[![Build Status](https://github.com/jmarrec/openstudio-backporter/actions/workflows/dev.yml/badge.svg)](https://github.com/jmarrec/openstudio-backporter/actions/workflows/dev.yml)
77
[![codecov](https://codecov.io/gh/jmarrec/openstudio-backporter/branch/main/graphs/badge.svg)](https://codecov.io/github/jmarrec/openstudio-backporter)
88

9-
109
A small library to backport an [OpenStudio](https://github.com/NREL/OpenStudio) OSM model to an older version.
1110
I am only adding backports as old as I need to.
1211

12+
* Documentation: <https://jmarrec.github.io/openstudio-backporter>
13+
* GitHub: <https://github.com/jmarrec/openstudio-backporter>
14+
* PyPI: <https://pypi.org/project/openstudio-backporter/>
15+
* TestPyPI: <https://test.pypi.org/project/openstudio-backporter/>
16+
17+
## Install
18+
19+
```shell
20+
pip install openstudio-backporter
21+
```
22+
23+
## Usage
24+
25+
### CLI
1326
A CLI feature is provided, that you can invoke via `python -m openstudiobackporter`
1427

1528
See `python -m openstudiobackporter --help` for the list of command line parameters and how to use it.
@@ -20,6 +33,8 @@ Example:
2033
python -m openstudiobackporter --to-version 3.8.0 --save-intermediate --verbose /path/to/model3_10_0.osm
2134
```
2235

36+
### Library
37+
2338
You can also use it as a library:
2439

2540
```python
@@ -35,11 +50,7 @@ backporter.backport(idf_file=model) # or model.toIdfFile()
3550
```
3651

3752

38-
* Documentation: <https://jmarrec.github.io/openstudio-backporter>
39-
* GitHub: <https://github.com/jmarrec/openstudio-backporter>
40-
* PyPI: <https://pypi.org/project/openstudio-backporter/>
41-
* TestPyPI: <https://test.pypi.org/project/openstudio-backporter/>
42-
53+
---
4354

4455
This is free software (MIT License) contributed by [EffiBEM](https://www.effibem.com).
4556

0 commit comments

Comments
 (0)