Skip to content

Commit 740faa5

Browse files
committed
Prepare for continuous deployment to PyPI
1 parent e834161 commit 740faa5

File tree

2 files changed

+18
-16
lines changed

2 files changed

+18
-16
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -42,20 +42,22 @@ for more information about the format and its usage in that project.
4242

4343
Write a configuration file in YAML format. A simple configuration file with two result variables looks like this:
4444

45-
model: OSeMBE v1.0.0
46-
scenario: DIAG-C400-lin-ResidualFossil
47-
region: iso2_x, iso3_x, from_csv, or a name of a country/region [substitute x with start, end, or a positive number]
48-
results:
49-
- iamc_variable: 'Carbon Capture|Biomass'
50-
tech_emi: ['(?=^.{2}(BM))^.{4}(CS)']
51-
emissions: [CO2]
52-
unit: kt CO2/yr
53-
transform: abs
54-
osemosys_param: AnnualTechnologyEmission
55-
- iamc_variable: 'Capital Investment'
56-
capacity: ['^.*$']
57-
unit: MUSD
58-
osemosys_param: CapitalInvestment
45+
```yaml
46+
model: OSeMBE v1.0.0
47+
scenario: DIAG-C400-lin-ResidualFossil
48+
region: iso2_x, iso3_x, from_csv, or a name of a country/region [substitute x with start, end, or a positive number]
49+
results:
50+
- iamc_variable: 'Carbon Capture|Biomass'
51+
tech_emi: ['(?=^.{2}(BM))^.{4}(CS)']
52+
emissions: [CO2]
53+
unit: kt CO2/yr
54+
transform: abs
55+
osemosys_param: AnnualTechnologyEmission
56+
- iamc_variable: 'Capital Investment'
57+
capacity: ['^.*$']
58+
unit: MUSD
59+
osemosys_param: CapitalInvestment
60+
```
5961
6062
The first section of the configuration file with the keys `model`, `scenario`, and `region` are used to define the metadata for
6163
the IAMC template.
@@ -67,7 +69,7 @@ the IAMC template.
6769
* `from_csv` - using the region as defined in the REGION column of the CSV file
6870
* Any other word or phrase the user defines (other than an invalid iso option) will be used as the region for all variables. eg. Austria, Nepal, Ethiopia, Guyana, etc.
6971

70-
\*The `x` in the above ISO options is to be replaced by:
72+
The `x` in the above ISO options is to be replaced by:
7173
* `start`, if the codes are at the beginning of the names
7274
* `end`, if the codes are at the end of the names, or
7375
* a positive number indicating the position of the first letter of the code in the name. eg. iso2_5 will target the 'GH' in 'POWRGHSOL'

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ author_email = wusher@kth.se
1111
license = MIT
1212
license_files = LICENSE.txt
1313
long_description = file: README.md
14-
long_description_content_type = text/x-markdown; charset=UTF-8
14+
long_description_content_type = text/markdown; charset=UTF-8
1515
url = https://github.com/osemosys/osemosys2iamc/
1616
project_urls =
1717
Source = https://github.com/osemosys/osemosys2iamc/

0 commit comments

Comments
 (0)