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

Update readme to reflect stable install #391

Merged
merged 16 commits into from
Apr 24, 2024
Merged

Update readme to reflect stable install #391

merged 16 commits into from
Apr 24, 2024

Conversation

sssangha
Copy link
Collaborator

Requirements file and mamba no longer translate to a stable build. Updating readme to reflect this

@sssangha sssangha requested review from bbuzz31 and mgovorcin March 30, 2024 00:33
@sssangha sssangha marked this pull request as ready for review March 30, 2024 00:36
@dbekaert
Copy link
Collaborator

@sssangha Is there a reason we fall back to the past approach?
I thought mamba was getting more preferred as it resolves faster than conda?

@dbekaert
Copy link
Collaborator

@sssangha lets disable the test for the water mask?

@bbuzz31
Copy link
Collaborator

bbuzz31 commented Mar 30, 2024

@sssangha Is there a reason we fall back to the past approach? I thought mamba was getting more preferred as it resolves faster than conda?

+1

@alexfore
Copy link
Collaborator

The issue here is that the README does not describe a working process to create a repeatable env in which to run this software. Specifically, the line conda install mamba does not work, presumably you also need to do something else (conda forge? I don't really know). Even after using the instructions in the modified readme I am not able to obtain the same results as Simran did while running on another machine with an env he created.

Before I can implement any testing suites I actually need to be able to replicate Simran's results on my machine with my env, as clearly what I have now fails all my tests. To do that we need a way to create envs for this software that work and give the same outputs when provided the same inputs and aria-tools software. Maybe your requirements file needs work to make this happen.

@sssangha
Copy link
Collaborator Author

sssangha commented Apr 1, 2024

@dbekaert and @bbuzz31 , I was able to confirm from Alex's suggestion that mamba works when specifying it can be found through conda-forge. I've updated the READme to be more explicit to reflect a stable installation that users can follow verbatim.

Will have to still figure out what's going wrong when using requirements vs the YML from scratch though.

@sssangha
Copy link
Collaborator Author

When the jupyter_contrib_nbextensions module was installed through pip originally, as opposed to through conda-forge, the following build installation error was raised:

(base) [ssangha@trappist ARIA-tools]$ mamba env create -f environment_ariatools_new2PRtest.yml
Retrieving notices: ...working... done
Channels:
 - conda-forge
 - defaults
Platform: linux-64
Collecting package metadata (repodata.json): done
Solving environment: done

Downloading and Extracting Packages:
                                                                                                                                                                                                                                
Preparing transaction: done                                                                                                                                                                                                     
Verifying transaction: failed                                                                                                                                                                                                   
                                                                                                                                                                                                                                
CondaVerificationError: The package for jsonschema-specifications located at /u/trappist-r0/ssangha/conda_installation/stable_april1_2024/pkgs/jsonschema-specifications-2023.12.1-pyhd8ed1ab_0                                 
appears to be corrupted. The path 'site-packages/jsonschema_specifications/schemas/draft201909/vocabularies/core'                                                                                                               
specified in the package manifest cannot be found.                                                                                                                                                                              
                                                                                                                                                                                                                                
CondaVerificationError: The package for jsonschema-specifications located at /u/trappist-r0/ssangha/conda_installation/stable_april1_2024/pkgs/jsonschema-specifications-2023.12.1-pyhd8ed1ab_0                                 
appears to be corrupted. The path 'site-packages/jsonschema_specifications/schemas/draft202012/vocabularies/core'                                                                                                               
specified in the package manifest cannot be found.                                                                                                                                                                              
                                                                                                                                                                                                                                
ClobberError: This transaction has incompatible packages due to a shared path.                                                                                                                                                  
  packages: conda-forge/linux-64::libkml-1.3.0-h01aab08_1018, conda-forge/linux-64::minizip-4.0.5-h0ab5242_0                                                                                                                    
  path: 'include/minizip/ioapi.h'                                                                                                                                                                                               
                                                                                                                                                                                                                                
                                                                                                                                                                                                                                
ClobberError: This transaction has incompatible packages due to a shared path.                                                                                                                                                  
  packages: conda-forge/linux-64::libkml-1.3.0-h01aab08_1018, conda-forge/linux-64::minizip-4.0.5-h0ab5242_0                                                                                                                    
  path: 'include/minizip/unzip.h'                                                                                                                                                                                               
                                                                                                                                                                                                                                
                                                                                                                                                                                                                                
ClobberError: This transaction has incompatible packages due to a shared path.                                                                                                                                                  
  packages: conda-forge/linux-64::libkml-1.3.0-h01aab08_1018, conda-forge/linux-64::minizip-4.0.5-h0ab5242_0                                                                                                                    
  path: 'include/minizip/zip.h'                                                                                                                                                                                                 
                                                                                                                                                                                                                                
                                                                                                                                                                                                                                
ClobberError: This transaction has incompatible packages due to a shared path.                                                                                                                                                  
  packages: conda-forge/linux-64::libkml-1.3.0-h01aab08_1018, conda-forge/linux-64::minizip-4.0.5-h0ab5242_0                                                                                                                    
  path: 'lib/libminizip.so'

@sssangha
Copy link
Collaborator Author

@cmarshak , agreed went ahead and adjusted the readme to reflect your suggestion. Specifically, install the package using miniforge

Copy link
Collaborator

@alexfore alexfore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also fix this line:

setenv PATH ${PATH}:${PWD}/tools/ARIAtools

which should be

setenv PATH ${PATH}:${PWD}/tools/bin

@sssangha
Copy link
Collaborator Author

Can you also fix this line:

setenv PATH ${PATH}:${PWD}/tools/ARIAtools

which should be

setenv PATH ${PATH}:${PWD}/tools/bin

done

@alexfore
Copy link
Collaborator

Hi @sssangha, this looks good. However, I think we also need to add the parallel and pytest packages to the mamba install.

@sssangha
Copy link
Collaborator Author

Hi @sssangha, this looks good. However, I think we also need to add the parallel and pytest packages to the mamba install.

Sure, done. I tested the new environment with these packages included and all looks good. The golden outputs I just shared for ariaDownload were successfully accessed using this environment.

@sssangha sssangha merged commit ce72d53 into dev Apr 24, 2024
0 of 4 checks passed
@alexfore alexfore deleted the sss_readmeupdate branch May 13, 2024 11:51
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.

5 participants