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

Installation and Docs need some improvements #62

Open
maurerle opened this issue Oct 30, 2023 · 1 comment
Open

Installation and Docs need some improvements #62

maurerle opened this issue Oct 30, 2023 · 1 comment

Comments

@maurerle
Copy link

Hi @jokochems ,
I would like to check this project out.

  1. pommesinvest is now released :) so one can link to it in the readme
  2. I think it is unnecessary to still have the setup.py as everything is part of pyproject.toml?
  3. the hard version requirement on oemof.solph seems weird?
  4. the conda create command takes very long - maybe updating to a supported python version would help? - installing on my own on worked flawless with
conda create -n pommesdispatch python=3.10 pandas pip numpy
conda activate pommesdispatch
pip install -e .
  1. I did not find docs on how to proceed from here - there is the script run_pommes_dispatch which says that the input folder is empty - which inputs from pommesdata should I put there? - oh I see there are more docs on https://pommesdispatch.readthedocs.io - maybe put this into the github description and as a link on the docs badge?

Would be very cool to have some more information on that to actually test this tool!

I think https://pommesdispatch.readthedocs.io/en/latest/usage.html#using helps me get along for now

@jokochems
Copy link
Member

jokochems commented Oct 30, 2023

Hi @maurerle, thank you for opening this issue.

  1. pommesinvest is now released :) so one can link to it in the readme

Thank you and you are right. There is no official GitHub release and PyPI uload yet, though.

  1. I think it is unnecessary to still have the setup.py as everything is part of pyproject.toml?

Yes, I agree.

  1. the hard version requirement on oemof.solph seems weird?

Indeed, it is. Be aware that I haven't been working on the repository for quite some time now and that newer oemof.solph version introduced some breaking changes which are not yet fully included.

  1. the conda create command takes very long - maybe updating to a supported python version would help? - installing on my own on worked flawless with
conda create -n pommesdispatch python=3.10 pandas pip numpy
conda activate pommesdispatch
pip install -e .

Thank you. I think python versions >= 3.8 should work.

  1. I did not find docs on how to proceed from here - there is the script run_pommes_dispatch which says that the input folder is empty - which inputs from pommesdata should I put there? - oh I see there are more docs on https://pommesdispatch.readthedocs.io - maybe put this into the github description and as a link on the docs badge?

Would be very cool to have some more information on that to actually test this tool!

I think https://pommesdispatch.readthedocs.io/en/latest/usage.html#using helps me get along for now

Thanks for the feedback. As stated in pommes-public/pommesdata#21, I can upload something to Zenodo shortly.

Of course, the cleaner way would be to update and fix dependencies. I could do so when I'm done with my analyses which I base on my current setting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants