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

"Full functionality" documentation for configuration language does not exist. #20

Open
ian-bertolacci opened this issue Jun 26, 2020 · 2 comments

Comments

@ian-bertolacci
Copy link

On the 'First Steps' tutorial, under 'Configure File' the last paragraph says: "The configuration language is small, but allows you to change a lot of the behavior of the system. The full functionality is documented here." but the link ("here") points to "doc/nope_not_yet" , which I assume is/was a placeholder link.

Does the full functionality documentation for the configuration language exist somewhere else and this link was simply a placeholder?

@nocollier
Copy link
Collaborator

You are correct, I have never made a list of all the things ILAMB recognizes. For now I have pushed a correction in the docs. The next time I render then, it will update in the tutorial. For now the best I have to offer you is to look at the CMIP configure file that we distribute with the software:

https://github.com/rubisco-sfa/ILAMB/blob/master/src/ILAMB/data/cmip.cfg

Essentially, I made ILAMB recognize the things we needed it to. It is also extensible. If you are writing your own Confrontation, all keywords will get passed into a keywords dictionary which you can parse in the code. For example, in the permafrost work, we needed to be able to control the threshold for freezing temperature which can be passed via this configure langugage:

https://github.com/rubisco-sfa/ILAMB/blob/master/src/ILAMB/ConfPermafrost.py#L74

Let me know if you have a specific question and I am happy to answer.

@ian-bertolacci
Copy link
Author

That makes sense. Is there any documentation about the derived algebraic language?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants