Skip to content

Add doc on install MintPy on Windows#647

Merged
yunjunz merged 6 commits intoinsarlab:mainfrom
Jlrine2:windows-doc
Aug 29, 2021
Merged

Add doc on install MintPy on Windows#647
yunjunz merged 6 commits intoinsarlab:mainfrom
Jlrine2:windows-doc

Conversation

@Jlrine2
Copy link
Contributor

@Jlrine2 Jlrine2 commented Aug 26, 2021

These changes add instructions for installing MintPy using Conda on Windows. It also fixes a few bugs that allow windows to run through the examples in the Readme.md file of this repo.

There are still likely bugs as I haven't done any extensive testing on windows.

Reminders

  • Pass Codacy code review (green)
  • Make sure that your code follows our style. Use the other functions/files as a basis.
  • If modifying functionality, describe changes to function behavior and arguments in a comment below the function declaration.
  • If adding new functionality, add a detailed description to the documentation and/or an example.

@yunjunz yunjunz self-requested a review August 27, 2021 01:48
@yunjunz
Copy link
Member

yunjunz commented Aug 27, 2021

Thank you @Jlrine2 for the PR. Your install note here is consistent with #497.

It seems to me that the installation order is:

  1. download source code via git clone (as in Installation.md#1, but without path setup)
  2. install dependencies via conda. Could we check if conda install --file MintPy/docs/requirements.txt works, as an alternative to conda env create -f MintPy/docs/environment.yml?
  3. install mintpy/pyaps via pip install -e.

The two environment variables MINTPY_HOME and PYAPS_HOME are not needed, according to #497.

@yunjunz
Copy link
Member

yunjunz commented Aug 27, 2021

From my understanding, with this note, one could use mintpy module in Python, but could not run mintpy scripts, such as smallbaselineApp.py in the command line. Is there a way of setup to make all scripts under MintPy/mintpy available to execute in the command line?

@Jlrine2
Copy link
Contributor Author

Jlrine2 commented Aug 27, 2021

It is definately possible to setup your install to allow entrypionts without needing to manually edit PATH's. @jhkennedy and I are working on getting MintPy into conda-forge, that will come with a few suggestions of which one will be adding those entrypoints.

Co-authored-by: Joseph H Kennedy <me@jhkennedy.org>
@jhkennedy
Copy link
Collaborator

Is there a way of setup to make all scripts under MintPy/mintpy available to execute in the command line?

The instructions now add MintPy/mintpy to the PATH, so you should be able to do this.

Could we check if conda install --file MintPy/docs/requirements.txt works, as an alternative to conda env create -f MintPy/docs/environment.yml?

Yes, that will work too, except the requirements.txt is missing gdal>=3 and the pip installs so users will have to add those. Do you want us to write instructions for both like the current via conda instructions?

Co-authored-by: Joseph H Kennedy <me@jhkennedy.org>
@yunjunz
Copy link
Member

yunjunz commented Aug 28, 2021

Yes, that will work too, except the requirements.txt is missing gdal>=3 and the pip installs so users will have to add those. Do you want us to write instructions for both like the current via conda instructions?

Great, yes please. That would be more flexible on the user side.

Update: I could write it based on your response. Thank you!

@yunjunz yunjunz changed the title Add documentation about using MintPy on Windows, and a few bug fixes Add doc on install MintPy on Windows Aug 29, 2021
@yunjunz yunjunz merged commit ab01556 into insarlab:main Aug 29, 2021
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

Successfully merging this pull request may close these issues.

3 participants