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

chore: add QuickStart section #171

Merged
merged 6 commits into from
Oct 22, 2024
Merged

chore: add QuickStart section #171

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
33637d0
adding a quickstart first draft
uriii3 Oct 17, 2024
93bb285
adding a quickstart first draft
uriii3 Oct 17, 2024
25378eb
doc: update the quick overwiew file
renaudjester Oct 18, 2024
5e5a164
typos and standarizing
uriii3 Oct 21, 2024
0c15f74
Python
uriii3 Oct 21, 2024
f92210d
more Python
uriii3 Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Commands:

## Python package (API)

The `copernicusmarine` exposes a Python interface to allow you to [call commands as functions](https://toolbox-docs.marine.copernicus.eu/).
The `copernicusmarine` exposes a python interface to allow you to [call commands as functions](https://toolbox-docs.marine.copernicus.eu/).
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think python needs to always be with capital P 🤔

Copy link
Collaborator

Choose a reason for hiding this comment

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

If it's not the case in the rest of the documentation we need to change this

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Mmh python maybe yes, but I looked at how python interface was written in the code and it was the only instance with capital letter. I tried to keep the code consistent.

But if it is better expressed with capital letters I can change the whole code too (doesn't have that many instances).


## Version management

Expand Down
19 changes: 7 additions & 12 deletions doc/usage/quickoverview.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The main functions (which we will explain later in more detail) are:\n",
"- Login: for authentication\n",
"- Describe: to get metadata from the Data Store\n",
"- Get: to download the native data\n",
"- Subset: to download specific (spatiotemporal) regions of interest\n",
"The main functions are:\n",
"- **Login**: for authentication\n",
"- **Describe**: to get metadata from the Data Store\n",
"- **Get**: to download the native data\n",
"- **Subset**: to download specific (spatiotemporal) regions of interest\n",
"\n",
"These four commands are available from the terminal (command line interface) and/or from a Python API (from scripts to notebooks!)\n"
]
Expand All @@ -50,11 +50,6 @@
"There are different ways to use the Copernicus Marine toolbox, using the **`pip`** command, **`mamba | conda`**, the docker image or the binaries. You can see more information in the [installation page](installation-page) of the documentation."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": []
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down Expand Up @@ -435,7 +430,7 @@
"\n",
"For more information, see the [page about subset](subset-page) of the documentation. You can also check the dedicated pages for the [command line interface](cli-subset) or the {func}`python interface <copernicusmarine.subset>`.\n",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

the difference in the 'output' or how the two functions are presented might be a little weird, but for me it works. Just to keep it in mind.

"\n",
"The subset is a powerful tool that allow you to benefit from the power the Copernicus Marine services. Indeed, not only do you have access to the whole catalogue but you also can pinpoint the data that interest you thanks to the two services: \"arco-geo-series\" and \"arco-time-series\". They are respectively optimised for retieving maps (short time spam, wide area) and time series (long time span, small area). "
"The subset is a powerful tool that allows you to benefit from the power the Copernicus Marine services. Indeed, not only do you have access to the whole catalogue but you also can pinpoint the data that interest you thanks to the two services: \"arco-geo-series\" and \"arco-time-series\". They are respectively optimised for retieving maps (short time spam, wide area) and time series (long time span, small area). "
]
},
{
Expand Down Expand Up @@ -1792,7 +1787,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Now if you have download this data, but you want to check if you data is up to data you can use the `sync` option. "
"Now if you have downloaded this data, but you want to check if your data is up to date you can use the `sync` option. "
]
},
{
Expand Down