Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The documentation needs to be updated #5

Open
Timon-R opened this issue Oct 9, 2023 · 3 comments
Open

The documentation needs to be updated #5

Timon-R opened this issue Oct 9, 2023 · 3 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Timon-R
Copy link

Timon-R commented Oct 9, 2023

First, there is an error in the OSEMBE documentation.
The naming convention of technologies is described as AABBCCDDEF (10 digits). It should only be one D (9 digits in total).

Second, the emission codes are unclear. I found the following ones for the example of Finland (scenario WP1_NetZero):

FIHO (water vapor?)
FIPM25 (this is particular matter 2.5)
FISO (sulfur dioxide?)
FIWI (?)
FIWO (Dummy?)

Third, the values for the E and F part of the code (age and size) are not clear. What does age H,N or D mean and what does size 1,2 or 3 mean?

Fourth, what is the meaning of energy level T and technology RF?

@HauHe HauHe added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Oct 10, 2023
@HauHe
Copy link
Collaborator

HauHe commented Oct 10, 2023

Hi @Timon-R,
thanks for spotting theses issues. I think most are typos/mistakes.
I will currently not manage to fix these issues. But I'm happy to provide guidance on how these things can be fixed. So if you have time, it would be great if you could:

  • Clone this repo (in case you haven't done so yet)
  • Fork this repo (in case you haven't done so yet)
  • Address these issues locally on your computer
  • Push them to your fork
  • Create Pull Request from you fork to this repo

regarding the issues:

  1. Correct, needs to be fixed in documentation
  2. Even though called emission, not all emissions in OSeMBE (and other OSeMOSYS models) are necessarily actual emissions. The emission set and parameter can also be used to limit the activity of multiple technologies. The emissions you picked are all related to Finland (FI). A 'real' emission is only:
  • PM25: particulate matter 2.5
    The others are used to limit the use of certain resources:
  • HO: hydro power
  • SO: solar pv
  • WI: wind power
  • WO: In the model version in this repo it is not included, but in other versions it is the limit for offshore wind, if so WI covers only onshore wind.
  1. If applicable H and N stand for historic (H) and new (N), but only selected technologies have a old and a new version. I assume that D comes from XXEL00TD0, where TD stands for 'Transmission and Distribution'. I think I created it like this to facilitate filtering of results in excel. But for consistency with the nomenclature 'XXELTD000' would have been more appropriate.
  2. For T see my answer under 3. (above). RF stands for 'refinery'

Let me know in case you have any questions.

@Timon-R
Copy link
Author

Timon-R commented Oct 10, 2023

Thank you @HauHe

What about the different size values?

@HauHe
Copy link
Collaborator

HauHe commented Oct 10, 2023

Sorry, missed that part of the comment.
They are merely indicative, with 1 being small, 2 medium, and 3 large.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants