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.

Sign up for GitHub

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

Jump to bottom

Update README.m #106

Closed
2 tasks
selipot opened this issue Feb 2, 2023 · 3 comments · Fixed by #116 or #120
Closed
2 tasks

Update README.m #106

selipot opened this issue Feb 2, 2023 · 3 comments · Fixed by #116 or #120
Assignees
@milancurcic

Comments

@selipot
Copy link
Member

selipot commented Feb 2, 2023

  • Move first and center the link to the documentation
  • move down the install section

What is now the recommended use of the .yml file? And as a corollary, the use of the clouddrift environment that can be created from it? I understand we removed this from the README some time ago.
@selipot selipot assigned selipot and milancurcic and unassigned selipot Feb 2, 2023
@philippemiron
Copy link
Contributor

philippemiron commented Feb 2, 2023 •
edited
Loading

The environment is there for two reasons:

  1. It is used by the github actions (tests, and website) to download the dependencies and install the latest version of clouddrift from the github repo.
  2. If someone wants a simple environment to test clouddrift latest code.

@selipot
Copy link
Member Author

selipot commented Feb 2, 2023

The environment is there for two reasons:

  1. It is used by the github actions (tests, and website) to download the dependencies and install the latest version of clouddrift from the github repo.

Great

  1. If someone wants a simple environment to test clouddrift latest code.

Ok cool so should we add this back in the README? As an example?

And right now I don't know what the test section is about? The automatic tests to make sure the whole library is consistent?

@philippemiron
Copy link
Contributor

We could add it back. Yes, there are automatic tests (e.g. https://github.com/Cloud-Drift/clouddrift/blob/main/tests/analysis_tests.py) that gets executed after each modification to validate the code.

philippemiron added a commit to philippemiron/clouddrift that referenced this issue Feb 18, 2023
@philippemiron
Update README.md
ff98efd 
Fix Cloud-Drift#106

- added details on how to use the `environment.yml`
- added a note on using the pip package
- added badges for the conda and pip packages
@philippemiron philippemiron mentioned this issue Feb 18, 2023
Merged
@milancurcic milancurcic reopened this Feb 20, 2023
milancurcic added a commit to milancurcic/clouddrift that referenced this issue Feb 20, 2023
@milancurcic
Bring the docs and examples links to the top; fixes Cloud-Drift#106
238f9e6
@milancurcic milancurcic mentioned this issue Feb 20, 2023
Merged
milancurcic added a commit that referenced this issue Feb 20, 2023
@milancurcic
Update README (#120)
16025ef 
* Use active language

* Remove note about system libraries

* Document installing locally with pip

* Bring the docs and examples links to the top; fixes #106

* Building on unsupported platforms
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@milancurcic milancurcic

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Philippemiron readme philippemiron/clouddrift
Update README milancurcic/clouddrift
3 participants
@philippemiron @milancurcic @selipot