Skip to main content

gimfu

A toolkit for generating future scenarios in AUTOUGH2.


Table of Contents

Installation

pip install -U gimfu

If you use conda, use the supplied environment.yml to create py311-gimfu. This installs packages using conda as much as possible before installing packages from PyPI.

conda env create -f environment.yml

Commands

Make Scenario

To build a scenario from a .cfg and its parts (.geners):

make_scenarios make_scenarios_sXXX.cfg

This will generate a folder with the scenario name. Use run_all_models.bat for Windows or ./run_all_models.sh for Linux/MacOS.

Convert SAVE file to INCON file

save2incon a.save b.incon

NOTE this command is used during the scenario run.

These packages may be required to generate a full scenario report:

  • LaTeX (latex, dvips)
  • gnuplot (gnuplot)
  • Ghostscript (gs)

License

gimfu is distributed under the terms of the MIT license.

Developer

Build and Publish

To bump version, create a tag, eg. v0.1.0

PyPI token is expected in ~/.pypirc

Publish to PyPI:

hatch build
hatch publish

TODO

  • xlwt only available in Python <= 3.11 if using conda, replace it with xlsxwriter

Metadata

Release files for gimfu 0.0.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gimfu 0.0.9
File Size Uploaded Provenance Actions
gimfu-0.0.9.tar.gz 63.1 kB Without provenance Details for gimfu-0.0.9.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for gimfu 0.0.9
File Interpreter ABI Platform Actions
gimfu-0.0.9-py3-none-any.whl Python 3 none any Details for gimfu-0.0.9-py3-none-any.whl

Total release size: 138.0 kB

Release files / gimfu-0.0.9.tar.gz

Download URL gimfu-0.0.9.tar.gz
Size 63.1 kB
Tags Source
SHA-256 checksum
How to use checksums
5da25166552815e33013e60cef1506dab1cde322831811ae79d9444a6c670d78
BLAKE2b-256 checksum
How to use checksums
0ef97611b91277302cf93cbe81610c60dad3966c8976d200accc3c5dffa93fb7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-httpx/0.28.1

Release files / gimfu-0.0.9-py3-none-any.whl

Download URL gimfu-0.0.9-py3-none-any.whl
Size 74.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d83645ba2f5774cf7a6d80efc9d696c84d79668455563a47e50999a5833d955f
BLAKE2b-256 checksum
How to use checksums
b44e9759a7bc3e7df6b7025b566a811b92958d2970766e6aed44620e9a0c1fcb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-httpx/0.28.1

Security for gimfu 0.0.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page