Giter VIP home page Giter VIP logo

Comments (8)

oloapinivad avatar oloapinivad commented on August 11, 2024 1

In the documentation, the part

Finally you can install ECmean4 directly from pip
> pip install ECmean4

can be misunderstood in the way that installation only from PyPI is possible.

Fair point, I will update the doc!

from ecmean4.

uwefladrich avatar uwefladrich commented on August 11, 2024

What is the esmpy package that ECmean4 is looking for? I did not find such a package on PyPI.

from ecmean4.

uwefladrich avatar uwefladrich commented on August 11, 2024

What is the esmpy package that ECmean4 is looking for? I did not find such a package on PyPI.

Answer to myself: I can see that there is an esmpy package on conda-forge, which is meant here.

So I guess that it would work in a conda environment (using environment.yml) but not direct installation from PyPI (with pip install ECmean4).

from ecmean4.

oloapinivad avatar oloapinivad commented on August 11, 2024

Hi @uwefladrich, exactly. ESMF is required for interpolation, and this is shipped via conda. Although I create the pypi package there is no way to run it unless you set up the environment via conda/mamba.

Installation details are here: https://ecmean4.readthedocs.io/en/latest/installation.html

On the long term I plan to replace ESMF with CDO which is a bit more common in our machines, so that we might be able to set it up also with pip.

from ecmean4.

uwefladrich avatar uwefladrich commented on August 11, 2024

Okay, installing from conda-forge is fine for me.

In the documentation, the part

Finally you can install ECmean4 directly from pip
> pip install ECmean4

can be misunderstood in the way that installation only from PyPI is possible.

from ecmean4.

oloapinivad avatar oloapinivad commented on August 11, 2024

Hi Uwe, I updated the documentation

https://ecmean4.readthedocs.io/en/latest/installation.html

This should work without the need of downloading the github code

mamba create -n ecmean "python>=3.8" xesmf
mamba activate ecmean
pip install ECmean4

from ecmean4.

uwefladrich avatar uwefladrich commented on August 11, 2024

[...]

mamba create -n ecmean "python>=3.8" xesmf
mamba activate ecmean
pip install ECmean4

Yes, I tested and that works!

Still, maybe you might want to make it even clearer that any installation procedure requires conda/mamba (due to dependencies on conda-forge package). I think there is nothing wrong with requiring conda, it just needs to be stated clearly. Otherwise, people might still misinterpret the "Using PyPi" heading as "Pip installation".

Somewhat related, but not exacly:

  • The environment.yml file should be minimal, i my opinion. coverage and pytest are probably not needed to run ECmean4.
  • I would put another environment file (e.g. environment-dev.yml) beside environment.yml in the root dir. You mention ecmean/utils/dev_environment.yml in the documentation, but that does not exist.

from ecmean4.

oloapinivad avatar oloapinivad commented on August 11, 2024

Thanks Uwe, all suggestions considered and - in theory - included! I am closing the issue, please feel free to reopen it if you spot other problems...

from ecmean4.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.