Conversation
* code: initial new package structure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: add licensing with reuse * code: update .gitignore * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: changes to datapackage.py * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update class diagram * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: implementation * code: new additions * code: modify puml file * code: add test_commons.py * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: new changes * new changes to source * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: add test_source.py * code: implement SourceCollection * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: source_collection * update puml * code: doc changes * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * pre-commit * doc: update design.md * code: modify example in parameter.py * doc: remove Collection class * code: export json schema * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * doc: remove Collection * pre-commit changes * doc: Container -> Collection * code: expand Source Collection * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update .github/workflows/ci.yaml remove pydeflate from CI Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update .gitignore remove pydeflate from .gitignore Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update .pre-commit-config.yaml quarterly updates Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update REUSE.toml remove pydeflate from REUSE.toml Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update REUSE.toml Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update technologydata/technology.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * new changes * Update technologydata/unit_value.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * code: update __init__.py description * Update REUSE.toml Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update REUSE.toml Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update REUSE.toml Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update REUSE.toml Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update pyproject.toml Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * code: remove params check in conftest.py * Update pyproject.toml Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * add author * Update technologydata/parameter.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update technologydata/datapackage.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update technologydata/source_collection.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * code: rework imports * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: fix imports * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update technologydata/source_collection.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * code: modify method name * Update technologydata/source_collection.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * code: update source_collection * code: kwargs source_collection * code: update to_json * code: modify from_json * code: add get method for SourceCollection * code: unit test get method for source_collection * Update technologydata/source_collection.py --------- Co-authored-by: Fabrizio Finozzi <fabriziofinozzi@Mac.homenet.telecomitalia.it> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com>
* doc: update class-diagram * code: technology collection * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: update technologycollection and technology definition * code: new changes to file * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: add override method for __str__ for Source and SourceCollection * code: update __str__ for source.py * code: finalize technology_collection unit tests * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * data: re-format solar_photovoltaics_example_04 * refactor * code: push forward the development * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: add hash and eq methods for Source and finalize get_source_collection * code: SourceCollection optional in Datapackage * code: new datapackage methods * code: docstring for to_datapackage * code: modify unit tests * code: new updates * code: remove to_datapackage * code: remove datapackage path * code: including Annotated and removing Parameters section * code: modify __eq__ method for Source * code: re-write __hash__ method * code: change SourceCollection.from_json --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* code: Flatten class structure by removing UnitValue * code: add reuse dependency * code: add tests for parameters.py * code: Require carrier for heating_value attribute * code: Add default values for optional attributes * code: Make sources for Parameter optional * code: Implement arithmetic operations on Parameters * code: Add start of custom unit registry and helpers * code: Move test into single file and linting * code: Add tests for extraction from pint.Unit objects * code: Add tests for currency conversion rates * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: Add tests for custom UnitRegistry * code: Rename currency code cache file * code: Dedicated registries for heating values and carriers * code: Add instructions files for GH copilot * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: Fix test using wrong ureg * code: use lru_cache * code: Add function to map from currency code to ISO3 * code: New frozendict dependency * code: remove unused import * code: add debug msgs * code: Fix usage of wrong registry for currency units * code: Ensure canonical names are used for units, carriers, hvs * code: Adjust test for canonical name usage * code: docstrings * doc: improve docstring * code: Disallow currency conversion in unit conversion * code: Name capture groups in regex * code: formatting * code: Fix test for disallowed currency conversion in .to * code: Draft currency conversion method * code: Rename arguments for consistency * code: Fix failing test due to wrong UnitRegistry being used * code: Add missing renames * code: Wait... didn't I already commit this? * code: Fix wrong dtype in function call * code: Fix issue with conversion rates * code: Fix alias for source arguments * code: Raise errors on invalid currency conversion calls * doc: Update docstream with more options * code: Fix tests to comply with new syntax * code: Bugfix wrong logic check in conversion rate function * code: Add dependency for pytest-xdist * code: Fix issue with cache when calling method repeadetly from different uregs * code: Fix mypy errors * code: Adjust ValueError msg for incompatible heating values * code: Add tests for heating value operations * code: Add test for carrier compatabilities * doc: Add draft doc for parameters.py * code: add stub for heating value conversion * code: add equality and power operations on parameters * code: remove decorator for updating pint attributes in favour of direct calls * code: Implement conversion between LHV and HHV * code: Bugfix incompatible carrier in dividing Parameter objects * code: Outsource HHVs and LHVs for energy carriers * doc: Update puml * doc: Add details on change_heating_value(...) function * code: fix wrong heating values in tests * code: Add simple combination logic for provenance/note/sources * code: start to solve mypy annotations * code: new update * code: in between commit * data: update solar_photovoltaics_example_03/technologies.json * data: update technologies.json * data: update example_04 data * code: update to parameter.py * code: remove any reference to UnitValue * code: switch off type checking for UnitRegistry * code: solve mypy comment in units.py * doc: update class-diagram * ci: ai-prototype and unit test fix * code: update parameter eq method * code: docstrings for Parameter methods and example_parameter * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * data: add input parameters.csv for currency_conversion * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code/data: add tests for change_currency * code: add extra check on magnitude * code: update change_currency * code: latest comments --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Fabrizio Finozzi <fabrizio.finozzi.business@gmail.com>
* code: Separate development dependencies from necessary dependencies * doc: Add note on installing dev depenencies * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: Fix packaging and pytest issues * doc: Update installation details * doc: Add copyright statement --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* code: Allow parameter mul and div with scalars * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: Fix missing imports * code: Fix int not allowed as scalar factor --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* code: solve test issue introducing Engineering Toolbox * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* modify energy_density.py to include SourceCollection for methane * code: add natural_gas * code: add ammonia * code: add wood (dry) * add HHV for carbon * code: add HHV for lignite * code: add coal * code: add methanol * add HHV for jet A * code: add gasoline * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * updates to energy_density.py * code: solve unit tests in test_parameter.py * code: Fix unit test * Update src/technologydata/constants/energy_density.py Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/utils/carriers.txt Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update src/technologydata/utils/carriers.txt Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> --------- Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: euronion <johannes.hampp@openenergytransition.org>
* skip tests that usually fail * code: type ignore pytest.mark.skip_test * code: change name of pytest marker * code: add automatic skip for webarchive tests * doc: modify the docstring in conftest
* doc: first draft of doc * new updates to docs * new update on docs * docs: update the contributing.md * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * extend doc and rename files * add linter for markdown * managed to exclude docs from mypy * Update docs/home/license.md Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update docs/home/license.md Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update docs/design.md Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * Update docs/faq.md Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> * doc: delete overrides/main.html * docs: remove api folder and its content * doc: update to documentation * re-work REUSE.toml * update logo * docs: update REUSE.toml, minor typos * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com>
… pre-prototype-2 This allows us to open a PR on GitHub; without a common history this is not possble. History was added by pull/merge with git pull origin master --allow-unrelated-histories --strategy=ours to ensure only the current version of the TD prototype is kept and the history is recorded, but has no effect on the repo.
Add technology data history
Collaborator
Author
|
@finozzifa FYI |
* code: ensure LHV and HHV have same units * code: add pre-commit changes * test: fix unit test * test: update unit test * test:ton to metric_ton * update doc * Update docs/user_guide/parameter.md Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com> --------- Co-authored-by: Johannes HAMPP <42553970+euronion@users.noreply.github.com>
* code: store_in_wayback private * doc: update class-diagram.puml
…rceCollection (#62) * code: update tech json file and from_json * code: new version of from_json * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update tests --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* code: Add to_currency for Technology and TechnologyCollection * code: Rename adjust_currency to to_currency for Parameter * doc: Update class diagramm * doc: Add simple docs for to_currency methods * code: fix mypy comments and minor static typing issue --------- Co-authored-by: Fabrizio Finozzi <fabrizio.finozzi.business@gmail.com>
* code: modify units.py * code: new attempt to modify registry function * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: add method to patch pint error handling register * code: add validation * code: update test * code: refine message * code: Fix and expand test * code: fix issues in CustomUndefinedUnitError * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add pre-commit * code: add some extra test --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: euronion <johannes.hampp@openenergytransition.org>
* doc: Add proposal for GrowthModels * doc: Add proposal for LearningModels * code: Add implementation for growth models and linear growth * doc: Document growth models and linear growth * code: Remove model default affected parameters * code: Fix up docstrings * code: Sort imports * code: Fix type annotations * spelling and doc-string fixes * code: Implement exponential growth * code: Cleanup * code: Implement logistical growth * code: Expand package structure * code: Revise implementation for GrowthModel(s), start with LinearGrowth * code: Expand the abstract GrowthModel class * code: Allow starting values to be only a subset of all missing parameters * code: Reimplement LogisticGrowth and ExponentialGrowth * code Fix mypy issues * code: Add missing scipy dependency * Revert "code: Add missing scipy dependency" This reverts commit c053bfc. * code: Add missing scipy dependency * code: Cleanup + add GompertzGrowth model * doc: Update docs on GrowthModels * code: Add simple tests for growth_model.py * code: Add GeneralLogisticGrowth and harmonise parameter names * code: Update tests * doc: Update class diagramm * doc: ValueError in docstring * code: Implement fitting and projections on TCs * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: Simplify signature * code: Address pydantic deprecations * code: basic tests for fit and project on TechnologyCollection * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: add more tests * code: Update uv.lock file * code: Add x0 to all growth model functions * doc: Update docs for GrowthModel and integration with TechnologyCollection * code: TODO ideas for growth_models.py * git: Ignore dev folder * code: Fix tests * code: Address mypy errors * code: Add support for pydantic in mypy * code: update mypy issues * code: update growth models * doc: change currency to_currency * code: fix mypy issues --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Fabrizio Finozzi <fabrizio.finozzi.business@gmail.com>
* Add simple README * Add LICENSE for GitHub * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * doc: changes to README.md --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Fabrizio Finozzi <fabrizio.finozzi.business@gmail.com>
* code: initial implementation * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code: update download method * code: new testr * code: new changes * doc: update doc * code: update data_accessory.py * code: fix unit test * code: download method. Raise ValueError if version is not provided * code: update docstring of def download * code: update unit test * doc: fix documentation * code: update urllib --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* doc: merge the Home pages into the landing page Fold Installation, Citing, Contacts and the FAQ into docs/index.md, and expand it with a description of the problem the package addresses, a runnable example harmonising two catalogues, a list of what the package provides and a table of the bundled datasets. Keep Release Notes and License as separate pages. Drop the Users page, which was entirely placeholder, and the four unanswered FAQ entries; retain the three that can be answered from the code. Update the release notes to cover all four released versions, correct the licence badge, which pointed at the PyPSA repository, and remove the Discord links, whose invite is no longer valid. * docs: Revise index.md * docs: Restore FAQ subsite * docs: Add GH hook for autogenerated release notes * ci: Add PR-label categorization for auto-generated release notes Group release notes into Breaking Changes/Features/Bug Fixes/Data/ Documentation/Other Changes based on the labels now applied on the repo. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: cdgaete <cdgaete@users.noreply.github.com> Co-authored-by: Johannes <42553970+euronion@users.noreply.github.com> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* code: move data_accessor * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * doc: license for .github/release.yml --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* doc: update dependencies and import paths * doc: update other links * doc: update REUSE.toml and docs/index.md
* doc: add a step-by-step tutorial The user guide is a reference for each class, not a learning path, so there was no end-to-end route from a single parameter to a finished data package. Add docs/tutorial/index.md, one page growing in complexity: a Parameter built by hand, wrapped into a Technology, collection and DataPackage, then the same shapes loaded from the bundled catalogues, compared across currencies and units, and saved and read back. Note three details the tutorial depends on: DataPackage takes name and version, get() matches its arguments as regular expressions, and to_currency() takes an ISO3 country code. * test: run the tutorial's code blocks as doctests in CI The tutorial's output blocks were hand-copied from a REPL, so they could drift from what the code actually produces without anyone noticing. Rewrite each code block into doctest syntax (>>>/... prompts, expected output inline) and add a dedicated, opt-in `pytest --test-docs` check that runs them, following the approach PyPSA uses for its own docs. A new "Docs" CI job runs it on every push/pull request to master. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * doc: rewrite tutorial introduction Reframe the opening around who the package is for and what it helps with, and note upcoming derived-parameter/consistency-check and growth-model capabilities. * doc: extend tutorial with derived parameters and growth models The rewritten introduction now promises equation-derived parameters, consistency checks, and growth-model projection, so add two closing sections demonstrating them: calculate_parameters()/check_consistency() on a Technology, and a growth-model curve fit and projected forward. Also drops the tutorial's manual data_path plumbing for DataAccessor, which prototype-2's data_accessor move made unnecessary. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * docs: Prevent multiprocessing warning in build * doc: separate Technology from DataPackage in the tutorial Section 2 built a Technology and immediately wrapped it in a DataPackage in the same block, so there was no point where a reader saw what a bare Technology looks like or how a TechnologyCollection holds more than one. Split it into three steps: build one Technology and print it, collect the same technology across three years into a TechnologyCollection, then bundle that alongside an unrelated technology into a DataPackage with its sources. Renumber the following sections accordingly and update the save/load roundtrip's expected technology count (1 -> 4). Also fixes two breaks left from in-progress edits: an invalid carrier/heating_value pair on the opening Parameter example, and a syntax error in the lifetime Parameter passed to the first Technology. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * docs: Revise tutorial * docs: Update equation section * revert: split doctest CI and mkdocs multiprocessing fix into follow-up PRs Both were CI/tooling changes unrelated to the tutorial content itself. Moved to feat/doctest-ci-followup and fix/mkdocs-multiprocessing-followup, each based on this branch, to be opened as separate PRs once this one merges. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> --------- Co-authored-by: cdgaete <cdgaete@users.noreply.github.com> Co-authored-by: Johannes <42553970+euronion@users.noreply.github.com> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
* ci: add weekly external link checker for docs Adds a lychee-based link checker (following PyPSA's approach) that scans docs/ and README.md for broken external links. Runs weekly via schedule plus workflow_dispatch, kept separate from the main CI so flaky external hosts never block pushes/PRs. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * docs: Fix incorret link to current technology-data docs --------- Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
* doc: add a step-by-step tutorial The user guide is a reference for each class, not a learning path, so there was no end-to-end route from a single parameter to a finished data package. Add docs/tutorial/index.md, one page growing in complexity: a Parameter built by hand, wrapped into a Technology, collection and DataPackage, then the same shapes loaded from the bundled catalogues, compared across currencies and units, and saved and read back. Note three details the tutorial depends on: DataPackage takes name and version, get() matches its arguments as regular expressions, and to_currency() takes an ISO3 country code. * test: run the tutorial's code blocks as doctests in CI The tutorial's output blocks were hand-copied from a REPL, so they could drift from what the code actually produces without anyone noticing. Rewrite each code block into doctest syntax (>>>/... prompts, expected output inline) and add a dedicated, opt-in `pytest --test-docs` check that runs them, following the approach PyPSA uses for its own docs. A new "Docs" CI job runs it on every push/pull request to master. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * doc: rewrite tutorial introduction Reframe the opening around who the package is for and what it helps with, and note upcoming derived-parameter/consistency-check and growth-model capabilities. * doc: extend tutorial with derived parameters and growth models The rewritten introduction now promises equation-derived parameters, consistency checks, and growth-model projection, so add two closing sections demonstrating them: calculate_parameters()/check_consistency() on a Technology, and a growth-model curve fit and projected forward. Also drops the tutorial's manual data_path plumbing for DataAccessor, which prototype-2's data_accessor move made unnecessary. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * docs: Prevent multiprocessing warning in build * doc: separate Technology from DataPackage in the tutorial Section 2 built a Technology and immediately wrapped it in a DataPackage in the same block, so there was no point where a reader saw what a bare Technology looks like or how a TechnologyCollection holds more than one. Split it into three steps: build one Technology and print it, collect the same technology across three years into a TechnologyCollection, then bundle that alongside an unrelated technology into a DataPackage with its sources. Renumber the following sections accordingly and update the save/load roundtrip's expected technology count (1 -> 4). Also fixes two breaks left from in-progress edits: an invalid carrier/heating_value pair on the opening Parameter example, and a syntax error in the lifetime Parameter passed to the first Technology. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * docs: Revise tutorial * docs: Update equation section * revert: drop doctest CI from this branch, kept for a follow-up PR This branch is meant to carry only the mkdocs multiprocessing fix. The doctest-CI addition (test/test_docs.py, the --test-docs option, and the Docs workflow) is being split into its own PR instead, tracked on feat/doctest-ci-followup. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * docs: Prevent multiprocessing warning in build mkdocs-git-revision-date-localized-plugin spawns a multiprocessing.Pool to compute git timestamps in parallel, which triggers a Python DeprecationWarning about fork() safety when run from mkdocs serve's multi-threaded live-reload process. Disable the plugin's parallel processing to avoid it; the docs site is small enough that serial git-log lookups add no noticeable build time. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> --------- Co-authored-by: cdgaete <cdgaete@users.noreply.github.com> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
* doc: add a step-by-step tutorial The user guide is a reference for each class, not a learning path, so there was no end-to-end route from a single parameter to a finished data package. Add docs/tutorial/index.md, one page growing in complexity: a Parameter built by hand, wrapped into a Technology, collection and DataPackage, then the same shapes loaded from the bundled catalogues, compared across currencies and units, and saved and read back. Note three details the tutorial depends on: DataPackage takes name and version, get() matches its arguments as regular expressions, and to_currency() takes an ISO3 country code. * test: run the tutorial's code blocks as doctests in CI The tutorial's output blocks were hand-copied from a REPL, so they could drift from what the code actually produces without anyone noticing. Rewrite each code block into doctest syntax (>>>/... prompts, expected output inline) and add a dedicated, opt-in `pytest --test-docs` check that runs them, following the approach PyPSA uses for its own docs. A new "Docs" CI job runs it on every push/pull request to master. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * doc: rewrite tutorial introduction Reframe the opening around who the package is for and what it helps with, and note upcoming derived-parameter/consistency-check and growth-model capabilities. * doc: extend tutorial with derived parameters and growth models The rewritten introduction now promises equation-derived parameters, consistency checks, and growth-model projection, so add two closing sections demonstrating them: calculate_parameters()/check_consistency() on a Technology, and a growth-model curve fit and projected forward. Also drops the tutorial's manual data_path plumbing for DataAccessor, which prototype-2's data_accessor move made unnecessary. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * docs: Prevent multiprocessing warning in build * doc: separate Technology from DataPackage in the tutorial Section 2 built a Technology and immediately wrapped it in a DataPackage in the same block, so there was no point where a reader saw what a bare Technology looks like or how a TechnologyCollection holds more than one. Split it into three steps: build one Technology and print it, collect the same technology across three years into a TechnologyCollection, then bundle that alongside an unrelated technology into a DataPackage with its sources. Renumber the following sections accordingly and update the save/load roundtrip's expected technology count (1 -> 4). Also fixes two breaks left from in-progress edits: an invalid carrier/heating_value pair on the opening Parameter example, and a syntax error in the lifetime Parameter passed to the first Technology. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * docs: Revise tutorial * docs: Update equation section * revert: drop mkdocs multiprocessing fix from this branch, kept for a follow-up PR This branch is meant to carry only the doctest-CI addition. The mkdocs-git-revision-date-localized-plugin multiprocessing fix (enable_parallel_processing: false) is being split into its own PR instead, tracked on fix/mkdocs-multiprocessing-followup. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * test: run the tutorial's code blocks as doctests in CI The tutorial's output blocks were hand-copied from a REPL, so they could drift from what the code actually produces without anyone noticing. Add a dedicated, opt-in `pytest --test-docs` check that parses the ``` py fenced blocks in docs/tutorial/index.md as doctest examples and runs them, following the approach PyPSA uses for its own docs. A new "Docs" CI job runs it on every push/pull request to master. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> --------- Co-authored-by: cdgaete <cdgaete@users.noreply.github.com> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
* code: add CODEOWNERS * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add pip audit to dependencies * code: initial config of pip-audit * code: initial config of pip-audit * code: improve ci * code: improve ci * code: add scorecard * add badge * code: remove pip-audit --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* doc: add pre-commit badge * code: add codeql * code: add dependabot * add SECURITY.md * modify scorecard.yml
Bumps the github-actions group with 8 updates: | Package | From | To | | --- | --- | --- | | [actions/checkout](https://github.com/actions/checkout) | `4` | `7` | | [actions/setup-python](https://github.com/actions/setup-python) | `5` | `7` | | [actions/cache](https://github.com/actions/cache) | `4` | `6` | | [github/codeql-action](https://github.com/github/codeql-action) | `3` | `4` | | [softprops/action-gh-release](https://github.com/softprops/action-gh-release) | `2` | `3` | | [actions/download-artifact](https://github.com/actions/download-artifact) | `6` | `8` | | [ossf/scorecard-action](https://github.com/ossf/scorecard-action) | `2.4.1` | `2.4.4` | | [actions/upload-artifact](https://github.com/actions/upload-artifact) | `4.6.1` | `7.0.1` | Updates `actions/checkout` from 4 to 7 - [Release notes](https://github.com/actions/checkout/releases) - [Commits](actions/checkout@v4...v7) Updates `actions/setup-python` from 5 to 7 - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](actions/setup-python@v5...v7) Updates `actions/cache` from 4 to 6 - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](actions/cache@v4...v6) Updates `github/codeql-action` from 3 to 4 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@v3...v4) Updates `softprops/action-gh-release` from 2 to 3 - [Release notes](https://github.com/softprops/action-gh-release/releases) - [Changelog](https://github.com/softprops/action-gh-release/blob/master/CHANGELOG.md) - [Commits](softprops/action-gh-release@v2...v3) Updates `actions/download-artifact` from 6 to 8 - [Release notes](https://github.com/actions/download-artifact/releases) - [Commits](actions/download-artifact@v6...v8) Updates `ossf/scorecard-action` from 2.4.1 to 2.4.4 - [Release notes](https://github.com/ossf/scorecard-action/releases) - [Changelog](https://github.com/ossf/scorecard-action/blob/main/RELEASE.md) - [Commits](ossf/scorecard-action@f49aabe...2d11466) Updates `actions/upload-artifact` from 4.6.1 to 7.0.1 - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](actions/upload-artifact@4cec3d8...043fb46) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '7' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions - dependency-name: actions/setup-python dependency-version: '7' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions - dependency-name: actions/cache dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions - dependency-name: github/codeql-action dependency-version: '4' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions - dependency-name: softprops/action-gh-release dependency-version: '3' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions - dependency-name: actions/download-artifact dependency-version: '8' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions - dependency-name: ossf/scorecard-action dependency-version: 2.4.4 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions - dependency-name: actions/upload-artifact dependency-version: 7.0.1 dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* code: set token permissions * code: update SECURITY.md * code: pin dependency for codeql-action/upload-sarif in scorecard.yml * code: pin depedendencies in workflows * code: pin depedendencies in workflows
* code: add __getitem__ to TechnologyCollection * code: add get_parameter to TechnologyCollection * code: add append and add methods * code: add append and add methods * code: new additions
The default data_path was resolved relative to the working directory, so load() only worked from the root of a repository checkout and created empty directories elsewhere. Default to the package's parsers directory, which is the same path in a checkout. Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
to() overwrote the internal pint quantity of the original parameter with the converted one, while magnitude and units stayed unchanged. Equations read the pint quantity, so a unit conversion changed the result of later calculations; isclose() had the same side effect. Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…148) Multiplying two parameters without heating value raised a TypeError (None * None), and a missing carrier was stored as the string "None". Handle missing carrier and heating value like __truediv__ does. Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Co-authored-by: Fabrizio Finozzi <fabrizio.finozzi.business@gmail.com>
* code: add version * code: update commit hash * code: add schema version * code: add schema version * feat: add integer schema version to JSON data files Store `schema_version` as the first key of `technologies.json` and `sources.json`, validated on load. Files with a different version are rejected; nested source collections inside parameters omit the key. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * test: pin data download test to commit with schema version Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: Fabrizio Finozzi <fabrizio.finozzi.business@gmail.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* doc: lead the parser examples with runnable code Both example pages opened with narrative before showing anything runnable, and neither showed how the raw data becomes the parsed output. Restructure both to the same shape: Quick start, pipeline diagram, worked row, parser steps, regeneration and outputs. Correct four inaccurate claims, on unit resolution, currency form, schema output paths and the worked row index. * docs: Simplify documentation for DEA storage data v10 * docs(tutorial): update Technology print output after #145 Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs(datasets): add dataset fact sheets and template Add standardized fact sheets for dea_energy_storage and manual_input_usa, a contributor page with a checklist and fact sheet template, and run the code blocks of all fact sheets as doctests so their content tables stay in sync with the shipped data. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs: replace dataset examples with Datasets section Add a top-level Datasets tab, remove the per-dataset example pages, shorten the parser user guide pages to class usage and point links to the fact sheets. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs: fix undefined names in landing page example Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs: Small tweaks * docs(datasets): rename quick start, move reproduce section, add license to citation Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs(datasets): rename Versions section to Available versions Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs: add dataset-factsheet agent skill Add a Claude Code skill with step-by-step instructions for writing a dataset fact sheet: where each fact comes from, how to generate the doctest outputs, checks for known limitations and for the reproduce call. The template stays in docs/contributing/adding_a_dataset.md, which now points to the skill; AGENTS.md points other agents to it. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs: addendum * chore: untrack stray agent worktree and ignore .claude/worktrees/ --------- Co-authored-by: cdgaete <cdgaete@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Bumps the github-actions group with 3 updates: [github/codeql-action/init](https://github.com/github/codeql-action), [github/codeql-action/analyze](https://github.com/github/codeql-action) and [github/codeql-action/upload-sarif](https://github.com/github/codeql-action). Updates `github/codeql-action/init` from 4.38.0 to 4.38.1 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@b96794f...1c5b675) Updates `github/codeql-action/analyze` from 4.38.0 to 4.38.1 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@b96794f...1c5b675) Updates `github/codeql-action/upload-sarif` from 4.38.0 to 4.38.1 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@b96794f...1c5b675) --- updated-dependencies: - dependency-name: github/codeql-action/init dependency-version: 4.38.1 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions - dependency-name: github/codeql-action/analyze dependency-version: 4.38.1 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions - dependency-name: github/codeql-action/upload-sarif dependency-version: 4.38.1 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* code: Track provenance for parameter operations * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
…ser (#154) * doc: lead the parser examples with runnable code Both example pages opened with narrative before showing anything runnable, and neither showed how the raw data becomes the parsed output. Restructure both to the same shape: Quick start, pipeline diagram, worked row, parser steps, regeneration and outputs. Correct four inaccurate claims, on unit resolution, currency form, schema output paths and the worked row index. * docs: Simplify documentation for DEA storage data v10 * code: manual_input to legacy_data * fix unit tests * code: new unit test * code: new unit test * code: new unit test * code: refactor commons.py * code/doc: legacy_data --> legacy_input_data * code: add new logic * code: adapt usage for tests * docs(tutorial): update Technology print output after #145 Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs(datasets): add dataset fact sheets and template Add standardized fact sheets for dea_energy_storage and manual_input_usa, a contributor page with a checklist and fact sheet template, and run the code blocks of all fact sheets as doctests so their content tables stay in sync with the shipped data. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs: replace dataset examples with Datasets section Add a top-level Datasets tab, remove the per-dataset example pages, shorten the parser user guide pages to class usage and point links to the fact sheets. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs: fix undefined names in landing page example Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs: Small tweaks * docs(datasets): rename quick start, move reproduce section, add license to citation Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs(datasets): rename Versions section to Available versions Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs: add dataset-factsheet agent skill Add a Claude Code skill with step-by-step instructions for writing a dataset fact sheet: where each fact comes from, how to generate the doctest outputs, checks for known limitations and for the reproduce call. The template stays in docs/contributing/adding_a_dataset.md, which now points to the skill; AGENTS.md points other agents to it. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs: addendum * code: add new carriers * chore: untrack stray agent worktree and ignore .claude/worktrees/ * code: update parser_v0134.py * code: fix old carriers * new units and carriers * code: add new fixes for tests * code: update parser_v0134.py * code/doc: update documentation * code/doc: update parser docs * code: update version * code: update unit tests * code: update data and doc * doc: update docs * docs: Revise tutorial and getting started (#151) * fix(parameter): multiply parameters without carrier or heating value Multiplying two parameters without heating value raised a TypeError (None * None), and a missing carrier was stored as the string "None". Handle missing carrier and heating value like __truediv__ does. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * fix(data_accessor): default data_path to the installed package The default data_path was resolved relative to the working directory, so load() only worked from the root of a repository checkout and created empty directories elsewhere. Default to the package's parsers directory, which is the same path in a checkout. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs: add short getting started page Introduce Parameter, Technology and TechnologyCollection, then load the DEA storage dataset, read lifetime and investment of a utility-scale lithium-ion battery in 2030 and compute the investment of a project. Each section links to the user guide for more. The page is run as a doctest and linked from the landing page and the tutorial. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * fix(parameter): do not modify the original in to() to() overwrote the internal pint quantity of the original parameter with the converted one, while magnitude and units stayed unchanged. Equations read the pint quantity, so a unit conversion changed the result of later calculations; isclose() had the same side effect. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs(getting_started): add equations, collections, currency and consistency Show an incompatible-units error, derive the total investment with calculate_parameters(), split collections into grouping, values from the DEA dataset and growth-model projections, and add sections on currency and inflation harmonisation and consistency checks. Link the bundled datasets. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs: rename getting started to Overview and move it with the tutorial into Home Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs(overview): add data package section, fold project investment into currencies Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs(overview): wording on projections, currencies and consistency checks Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs(tutorial): rewrite as a beginner tutorial around one electrolyser example Build one hydrogen electrolyser example step by step: parameters and units, currencies and price years, carriers and heating values, sources, technologies, equations, collections and projections, data packages, and the bundled datasets. Each step explains why the concept exists. The dataset comparison and concatenation are dropped. Move "who this package is for" to the landing page and correct its claim that currency conversions record provenance. Move the regex warning of get() to the TechnologyCollection guide. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs(contributing): rename API improvement proposals to Improvement backlog, add tutorial findings Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * docs: Refinements --------- Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * doc: fix doc tests * code: Cleanup carrier alias names * data: Fix units in parser * data: less parameters * data: Fix heating values and carriers * docs: Update description of the legacy parser * data: Update legacy parser for consistency * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * doc: Move parser documentation * docs: Fix mkdocs entries * code: Update skill for creating dataset factsheets * docs: Restructure parser documentation * docs: Update navigation * code: Skill updates * code: Agent instruction updates * docs: Fix paths * docs: Update docstrings in parsers * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * docs: Post merge with prototype-2 branch corrections --------- Co-authored-by: cdgaete <cdgaete@users.noreply.github.com> Co-authored-by: Johannes <42553970+euronion@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
…og (#157) * doc: documentation for package release * doc: doc updates * doc: update doc
Bumps the github-actions group with 3 updates: [github/codeql-action/init](https://github.com/github/codeql-action), [github/codeql-action/analyze](https://github.com/github/codeql-action) and [github/codeql-action/upload-sarif](https://github.com/github/codeql-action). Updates `github/codeql-action/init` from 4.38.1 to 4.38.2 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@1c5b675...2892aa5) Updates `github/codeql-action/analyze` from 4.38.1 to 4.38.2 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@1c5b675...2892aa5) Updates `github/codeql-action/upload-sarif` from 4.38.1 to 4.38.2 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@1c5b675...2892aa5) --- updated-dependencies: - dependency-name: github/codeql-action/init dependency-version: 4.38.2 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions - dependency-name: github/codeql-action/analyze dependency-version: 4.38.2 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions - dependency-name: github/codeql-action/upload-sarif dependency-version: 4.38.2 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Supersedes #223 .
We've pivot from the first prototype to a different underlying structure that we are more happy with.
This is the new/ongoing prototype development.
Documentation endpoint: https://technology-data--240.org.readthedocs.build/en/240/