search

Ocean-Data-Lab / ooipy

Python library and demo code for processing and visualization of data from Ocean Observatories Initiative (OOI)
https://ooipy.readthedocs.io/en/latest/
MIT License
15 stars 8 forks source link

Changed development environment setup procedure #156

Closed anishdixit-uw closed 1 year ago

anishdixit-uw commented 1 year ago

Don's process added in using pip install -e ooipy.

anishdixit-uw commented 1 year ago

@John-Ragland , this is ready to merge

John-Ragland commented 1 year ago

Closes #155

John-Ragland commented 1 year ago

Closes #154

lsetiawan commented 1 year ago

I don't see a step to install the dev requirements... should there be one?

anishdixit-uw commented 1 year ago

I don't see a step to install the dev requirements... should there be one?

@lsetiawan I am unsure about this, I thought pip install -e ooipy would install those too.

If i am wrong, are you aware of what command would install the dev requirements? Would a pip install -r dev_requirements.txt work?

John-Ragland commented 1 year ago

I don't see a step to install the dev requirements... should there be one?

@lsetiawan I am unsure about this, I thought pip install -e ooipy would install those too.

If i am wrong, are you aware of what command would install the dev requirements? Would a pip install -r dev_requirements.txt work?

Yeah, pip install -r dev-requirements.txt should work. I think that we will eventually use the features of hatch and the optional install stuff (which I still don't fully understand). But for this PR we should be good to just use this command.

lsetiawan commented 1 year ago

Ditto. Also, the extra dependencies are not only specific to hatch. It can also be used with setuptools which is your current build frontend. It's simply just a way to install packages in addition to your default packages. This way say you have a listing for 'development' packages, you can then install by doing 'pip install -e "ooipy[development]"'. This tells pip to install packages for development as well. Without specifying the brackets, it's installing the minimal requirement. Makes sense?

anishdixit-uw commented 1 year ago

Thanks @lsetiawan , that helps!

anishdixit-uw commented 1 year ago

@John-Ragland , made all the changes, plz check and merge if it seems good!