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

README.md in build misses description #1930

Closed
visr opened this issue Nov 11, 2024 · 1 comment · Fixed by #1935
Closed

README.md in build misses description #1930

visr opened this issue Nov 11, 2024 · 1 comment · Fixed by #1935
Labels
CI/CD Continuous Integration/Continuous deployment

Comments

@visr
Copy link
Member

visr commented Nov 11, 2024

The last release that is ok is v2024.7.0, with this README.md in the builds:

# Ribasim CLI

This is a [Julia](https://julialang.org/) project that uses the [Ribasim](https://github.com/Deltares/Ribasim) Julia package, puts a simple command line interface (cli) on top, and packages this into a standalone application using [PackageCompiler.jl](https://github.com/JuliaLang/PackageCompiler.jl).

This enables using Ribasim without having to install Julia, and thus makes it more convenient to use in certain settings where installation must be simple and no interactive Julia session is needed.

If you have installed Julia and Ribasim, a simulation can also be started from the command line as follows:

    julia --eval 'using Ribasim; Ribasim.main("path/to/model/ribasim.toml")'

With a Ribasim CLI build this becomes:

    ribasim path/to/model/ribasim.toml

All releases since have this instead:

No documentation found.

Binding `build_app` does not exist.

The version section is also wrong:

release = "2024.10.0-128-ge09eeb5"
commit = "https://github.com/Deltares/Ribasim/tree/e09eeb5b9a"
branch = "https://github.com/Deltares/Ribasim/tree/main"
julia_version = "1.10.5"
core_version = "2024.11.0"

But that is #1655

@visr visr added the CI/CD Continuous Integration/Continuous deployment label Nov 11, 2024
@github-project-automation github-project-automation bot moved this to To do in Ribasim Nov 11, 2024
@visr
Copy link
Member Author

visr commented Nov 11, 2024

I suggest a shorter and simpler readme like this:

Ribasim

Ribasim is a water resources model to simulate the physical behavior of a managed open water system based on a set of control rules and a prioritized water allocation strategy.

Usage: ribasim path/to/model/ribasim.toml
Documentation: https://ribasim.org/

Version

This build uses the Ribasim version mentioned below.

release = "2024.11.0"
commit = "https://github.com/Deltares/Ribasim/tree/e09eeb5b9a"
branch = "https://github.com/Deltares/Ribasim/tree/main"
julia_version = "1.10.5"

visr added a commit that referenced this issue Nov 14, 2024
I used the shorter readme text from #1930, and moved the longer text to the README.md in https://github.com/Deltares/Ribasim/tree/main/build.

Fixes #1930.
visr added a commit that referenced this issue Nov 14, 2024
I used the shorter readme text from #1930, and moved the longer text to
the README.md in https://github.com/Deltares/Ribasim/tree/main/build.

Fixes #1930.
@github-project-automation github-project-automation bot moved this from To do to ✅ Done in Ribasim Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Continuous Integration/Continuous deployment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant