You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-6
Original file line number
Diff line number
Diff line change
@@ -20,11 +20,11 @@ The `message_ix` Python package—also fully usable from R—includes:
20
20
- Application programming interfaces (APIs) and tools for model building and scientific programming,
21
21
- Extensive documentation and a complete test suite.
22
22
23
-
The framework is built on IIASA's [*ix* modeling platform (`ixmp`)](https://github.com/iiasa/ixmp), which provides data warehouse features for high-powered numerical scenario analysis.
23
+
The framework is built on IIASA's [*ix* modeling platform (`ixmp`)](https://github.com/iiasa/ixmp), which provides data warehouse features for numerical scenario analysis.
24
24
25
25
## Documentation
26
26
27
-
Complete documentation of the framework is avaiable at **https://docs.messageix.org/**.
27
+
Complete documentation of the framework is available at **https://docs.messageix.org**.
28
28
This includes:
29
29
30
30
-**Installation** and recommended pre-requisite learning.
@@ -39,19 +39,27 @@ This includes:
39
39
Other forms of documentation:
40
40
41
41
- The online documentation is built automatically from the contents of the
- Documentation for the ‘latest’ or ‘stable’ release is shown by default.
44
44
- Use the chooser to access the [‘latest’ version](https://docs.messageix.org/en/latest/), corresponding to the ``main`` branch and including the latest development code; or to access docs for a specific release, e.g. `v3.2.0`.
45
45
- For offline use, the documentation can be built from the source code.
46
46
See the file [`doc/README.rst`](doc/README.rst)
47
47
48
48
## Commitment to our Community
49
49
50
-
- We aim to create a community that is welcoming to everyone. Please respect our [Code of Conduct](CODE_OF_CONDUCT.md) at all times when interacting with `message_ix` and the community.
50
+
- We aim to create a community that is welcoming to everyone.
51
+
Please respect our [Code of Conduct](CODE_OF_CONDUCT.md) at all times when interacting with `message_ix` and the community.
51
52
- We warmly welcome all contributions to our community. Please take a look at our [guidelines for contributing to development](https://docs.messageix.org/en/latest/contributing.html).
52
53
- If you are looking to understand how the `message_ix` team operates and how we decide what to do with your contributions, please read our [governance guidelines](GOVERNANCE.md).
53
-
- We highly value code security. To learn more about our security practice and advice, please visit our [security policy](.github/SECURITY.md).
54
-
- We strive to entertain a welcoming and inclusive community. If you struggle to use `message_ix`, please check our [guidelines for getting support](SUPPORT.md).
54
+
- We highly value code security.
55
+
To learn more about our security practice and advice, please visit our [security policy](.github/SECURITY.md).
56
+
- We strive to entertain a welcoming and inclusive community.
57
+
If you struggle to use `message_ix`, please check our [guidelines for getting support](SUPPORT.md).
58
+
- We also:
59
+
- Host an annual [MESSAGEix Community Meeting](https://iiasa.ac.at/search?search_api_fulltext=MESSAGEix+Community+Meeting).
60
+
- Publish, at least once per year, a community newsletter.
61
+
You are cordially invited to subscribe by filling [this form](https://iiasa.ac.at/signup) and ticking the box for “MESSAGEix Community”.
Copy file name to clipboardExpand all lines: doc/index.rst
+10-5
Original file line number
Diff line number
Diff line change
@@ -143,15 +143,20 @@ Everyone is required to please follow our Code of Conduct, which you can find `o
143
143
144
144
.. _help:
145
145
146
-
Have a question? Check…
147
146
148
-
- …on GitHub:
147
+
For further information and to get involved with the MESSAGEix user/developer community:
149
148
150
-
- Join an existing `discussion <https://github.com/iiasa/message_ix/discussions>`_ or start a new one with your question.
149
+
- Check on GitHub:
150
+
151
+
- Join an existing `discussion <https://github.com/iiasa/message_ix/discussions>`_ or start a new one with your MESSAGEix usage question.
151
152
- Search `current issues <https://github.com/iiasa/message_ix/issues?q=is:issue>`_, or open a new one to report a bug in the code.
152
153
153
-
- …the :doc:`faq`.
154
-
- …the message_ix Google Group, either `online <https://groups.google.com/d/forum/message_ix>`_ or via e-mail at <[email protected]>.
154
+
- See the less frequently updated :doc:`faq` and message_ix Google Group, either `online <https://groups.google.com/d/forum/message_ix>`_ or via e-mail at <[email protected]>.
155
+
156
+
.. _newsletter:
157
+
158
+
- We cordially invite you to subscribe to the **MESSAGEix Community Newsletter** by filling `this form <https://iiasa.ac.at/signup>`__ and ticking the box for "MESSAGEix-Community".
159
+
At least once a year, we update all subscribers on the latest research and ongoing projects regarding MESSAGEix and invite you to our annual `Community Meeting <https://iiasa.ac.at/search?search_api_fulltext=MESSAGEix+Community+Meeting`__.
0 commit comments