FZJ-IEK3-VSA / FINE

The FINE python package provides a framework for modeling, optimizing and assessing energy systems
https://vsa-fine.readthedocs.io
Other
68 stars 39 forks source link

[JOSS] Installation #47

Closed GregorBecker closed 1 month ago

GregorBecker commented 6 months ago

Hi this is a question regarding the installation from JOSS Review 6274

I'm not quite sure why you decided to use a mamba-only installation procedure of your energy system modeling tool.

Since I am developing without the use of conda, I had to install micromamba exclusively for your package "FINE".

It would be better to give users the flexibility to choose their virtual environment on their own, so that they can either use Conda, mircomamba or a virtual environment solution of their choice. It is necessary to mention the possibility of using a Python virtual environment as an alternative which does not require additional installations.

Possible solution would be (for MacOS users):

python3 -m venv Your Directory pip3 install fine

In my opinion, a description of the creation of virtual environments would not be necessary. A link to the relevant instructions would be sufficient.

Additionally it would be nice if the installation instruction in your documentation gets it's own menu button to be easier accessable via the documentation.

Kind Regards @GregorBecker

t-gross commented 1 month ago

Hi, I apologize that it took so long to work on the paper issues. We have put the installation instructions on our readTheDocs page. So, it is also possible to access it via the menu. In the ReadMe, there is only a short description with the recommended way to install and a link to the more detailed description on readTheDocs.

Thanks for raising the issue. Kind regards, @t-gross