I actually believe we may move away from having our own Mimi Registry and towards just registering packages directly in the General Registry in Julia for various reasons I can share if you are curious, but the goal is to optimize for a smooth user experience and minimize upkeep and thus potential for bottlenecks or failures.
Use as a Package:
You are right that MimiPAGE2020 is not currently set up as a Package, nor registered in the Mimi or General Registries. In fact, it is not necessary to register a package to have it accessible via the Pkg
add interface (Models as Packages · Mimi.jl), and I think James was thinking of taking those steps soon so that it will be addable via
pkg> add https://github.com/openmodels/MimiPAGE2020.jl
which does not require actually registering it with the General registry … @jrising can I help you with that? I see this PR which looks pretty close to ready to go?
This would make your environment situation easier @parthum .
We do have a somewhat consistent story for a few public API calls (
get_model, etc.) that many of the models implemented in Mimi adhere to, however that is ultimately up to the model creators.
We have considered adding some documentation instructing on the best practices for making your model a package and including our suggested API here and I can bump that to the top of my list if developers and users think this would be helpful.
That is to say making
MimiPAGE2020 addable as a package will not automatically create a consistent API, and if there are specific functions that would help your work I encourage you to reach out to @jrising here or as an issue on the repository to request those! I can also help do that.