#readthedocs — Public Fediverse posts

@martin_ueding TIL you can use #zensical on #readthedocs #rtd https://docs.readthedocs.com/platform/latest/intro/zensical.html

@martin_ueding TIL you can use #zensical on #readthedocs #rtd https://docs.readthedocs.com/platform/latest/intro/zensical.html

Experimentally, it seems like pushing new "build style" semver tags is sufficient to get #ReadTheDocs / #RTD to update its 'stable' pointer. That'll probably do for now?

E.g., I cut Paramiko 5.0.0+rtd1 and pushed it to GitHub but nowhere else (as it is literally 5.0.0 + a change to my RTD config files which do not impact any users or even contributors, really) and I'm seeing a rebuild w/ its SHA 🎉

Still more friction than I remember, but at least it's better than making a whole new release!

Experimentally, it seems like pushing new "build style" semver tags is sufficient to get #ReadTheDocs / #RTD to update its 'stable' pointer. That'll probably do for now?

E.g., I cut Paramiko 5.0.0+rtd1 and pushed it to GitHub but nowhere else (as it is literally 5.0.0 + a change to my RTD config files which do not impact any users or even contributors, really) and I'm seeing a rebuild w/ its SHA 🎉

Still more friction than I remember, but at least it's better than making a whole new release!

Weird, I could /swear/ #ReadTheDocs' 'stable' version used to track branches only, but the docs and changelog imply it's been branches /or tags/ (and critically, /favoring the latter when both exist/) since like 2018? Am I high?

The behavior as-is makes it hard to push #RTD-only or doc-only changes w/o cutting a whole new tag (and of course, cutting a whole new tag w/o releasing any code to PyPI, looks weird).

I.e., I can't just push a minor config tweak to my 5.0 branch to fix an issue with the 'stable' docs.

Somewhat ironically, my own changelog setup still creates links to 'latest' instead of 'stable' 🙃 but 'stable' is the default otherwise…

Weird, I could /swear/ #ReadTheDocs' 'stable' version used to track branches only, but the docs and changelog imply it's been branches /or tags/ (and critically, /favoring the latter when both exist/) since like 2018? Am I high?

The behavior as-is makes it hard to push #RTD-only or doc-only changes w/o cutting a whole new tag (and of course, cutting a whole new tag w/o releasing any code to PyPI, looks weird).

I.e., I can't just push a minor config tweak to my 5.0 branch to fix an issue with the 'stable' docs.

Somewhat ironically, my own changelog setup still creates links to 'latest' instead of 'stable' 🙃 but 'stable' is the default otherwise…

🎉 Release 2.0 of the #python package #pyam_iamc for #dataviz and #scenario analysis of #IntegratedAssessment, #EnergySystems & #MacroEnergy models.

Code #OpenSource on #GitHub, docs & tutorials hosted on #ReadTheDocs, discussion fora via groups.io and #Slack.

⚠️The new release removes support for #python earlier than 3.10 for easier maintenance and streamlined development going forward...

Check out the release details at https://github.com/IAMconsortium/pyam/releases/tag/v2.0.0

🎉 Release 2.0 of the #python package #pyam_iamc for #dataviz and #scenario analysis of #IntegratedAssessment, #EnergySystems & #MacroEnergy models.

Code #OpenSource on #GitHub, docs & tutorials hosted on #ReadTheDocs, discussion fora via groups.io and #Slack.

⚠️The new release removes support for #python earlier than 3.10 for easier maintenance and streamlined development going forward...

Check out the release details at https://github.com/IAMconsortium/pyam/releases/tag/v2.0.0

One headache in modeling & scenario analysis are inconsistent country names across different data sources.
So we developed an open-source #Python package to harmonize names in the #IntegratedAssessment & #EnergySystems communities...

The country names are based on ISO3166-1 standards, and the package has a few utility features to streamline modeling & analysis.

#ReadTheDocs at https://nomenclature-iamc.readthedocs.io/en/stable/api/countries.html, or visit the #GitHub repo at https://github.com/iamconsortium/nomenclature

One headache in modeling & scenario analysis are inconsistent country names across different data sources.
So we developed an open-source #Python package to harmonize names in the #IntegratedAssessment & #EnergySystems communities...

The country names are based on ISO3166-1 standards, and the package has a few utility features to streamline modeling & analysis.

#ReadTheDocs at https://nomenclature-iamc.readthedocs.io/en/stable/api/countries.html, or visit the #GitHub repo at https://github.com/iamconsortium/nomenclature

To review the (draft) update of national #SSP projections for #GDP and #population, you can...

1. View the data via our interactive #ScenarioExplorer hosted by the #IIASA #ScenarioServices team
2. Download the full dataset as xlsx
3. Access the data via our #Python or #Rstats API

And with our #opensource package #pyam_iamc, it's as easy as the snippet below...
... to get something that's just like a #pandas #DataFrame - but better!

#ReadTheDocs at https://pyam-iamc.readthedocs.io

To review the (draft) update of national #SSP projections for #GDP and #population, you can...

1. View the data via our interactive #ScenarioExplorer hosted by the #IIASA #ScenarioServices team
2. Download the full dataset as xlsx
3. Access the data via our #Python or #Rstats API

And with our #opensource package #pyam_iamc, it's as easy as the snippet below...
... to get something that's just like a #pandas #DataFrame - but better!

#ReadTheDocs at https://pyam-iamc.readthedocs.io

Just in time for the #openmod workshop hosted by the #IIASA #Energy #Climate & #Environment program...

🎉New release v1.8 of our #opensource #python package #pyam_iamc for #scenario analysis & #dataviz!

1. Jonas Hirsch & Matt Gidden refactored the internal #pandas data handling, so initializing an #IamDataFrame is now up to 3x faster for large datasets!
2. @PietroMonticone fixed a few typos in the #tutorials...

#ReadTheDocs 👉 https://pyam-iamc.readthedocs.io/

Just in time for the #openmod workshop hosted by the #IIASA #Energy #Climate & #Environment program...

🎉New release v1.8 of our #opensource #python package #pyam_iamc for #scenario analysis & #dataviz!

1. Jonas Hirsch & Matt Gidden refactored the internal #pandas data handling, so initializing an #IamDataFrame is now up to 3x faster for large datasets!
2. @PietroMonticone fixed a few typos in the #tutorials...

#ReadTheDocs 👉 https://pyam-iamc.readthedocs.io/

There's been tremendous progress to #freethemodels for #energysystems modelling! However, when it comes to #dataprocessing, scenario analysis & #dataviz, there's much less collaborative effort...

If you use #python for working with #energy or #climate scenarios, check out our #opensource package #pyam_iamc at https://pyam-iamc.readthedocs.io - we have plenty of tutorials to help you get started!
#github #pypi #conda #readthedocs

Is there a way to get #ReadTheDocs documentation onto #Devhelp? Would very much increase the scope! :gnomewhite:

Joined the #documentationteam of the #xerte project. Yesterday 2 online meetings and an afternoon of setting up #readthedocs
Xerte project website: https://xerte.org.uk