chore: clean the readme to the minimum and put the information in the… #145
Conversation
doc/installation.rst
Outdated
|
|
||
| .. note:: Requires Python 3.9 or higher. | ||
|
|
||
| Via conMamba | Condada (conda-forge channel) |
There was a problem hiding this comment.
conMamba? Condada? Not this, no?
|
|
||
| - ``--bounding-box-method inside``: | ||
| - Returns longitudes within the range: [0.08334, 0.917] | ||
|
|
||
| - ``--bounding-box-method nearest``: | ||
| - Returns longitudes: [0.0, 2.917] | ||
|
|
||
| - ``--bounding-box-method outside``: | ||
| - Outputs longitudes from: [0.0, 3.0] | ||
|
|
There was a problem hiding this comment.
this looks really weird! I don't know if there is any way maybe to mark all the parts that are not readable and then correct them later? This one will be outdated in no-time
There was a problem hiding this comment.
I'll let you correct it then
doc/usage/subset-usage.rst
Outdated
| About ``--netcdf3-compatible`` option | ||
| """""""""""""""""""""""""""""""""""""""" | ||
|
|
||
| The ``--netcdf3-compatible`` option enables compatibility with the netCDF3 format. This uses the ``format="NETCDF3_CLASSIC"`` setting in the xarray `to_netcdf` method. [Documentation link](https://docs.xarray.dev/en/latest/generated/xarray.Dataset.to_netcdf.html). |
There was a problem hiding this comment.
this link is not properly seen, I don't know what is happening!
| > copernicusmarine login | ||
| username : johndoe | ||
| password : | ||
| INFO - Configuration files stored in /Users/foo/.copernicusmarine | ||
|
|
There was a problem hiding this comment.
this is outdated, my problem!
|
|
||
| If the ``.copernicusmarine-credentials`` file already exists, the system will ask for confirmation before overwriting it (using the ``--overwrite`` or ``--overwrite-configuration-file`` options). | ||
|
|
||
| You can also use the ``--skip-if-user-logged-in`` option to prevent overwriting the configuration file if the user is already logged in. |
There was a problem hiding this comment.
what is this about? it shouldn't ask suer to login if they have the credentials, no?
| Access Points Migration and Evolution | ||
| ------------------------------------- | ||
|
|
||
| If you still have configurations for legacy services (for example, files like ``~/motuclient/motuclient-python.ini``, ``~/.netrc``, or ``~/_netrc`` in your home directory), these will automatically be recognized by the ``get`` and ``subset`` commands without needing to run the ``login`` command. | ||
|
|
||
| If your configuration files are stored in a different directory, you can point to them by using the ``--credentials-file`` option when running the ``get`` or ``subset`` commands. |
There was a problem hiding this comment.
Maybe also recommend to update to the newer version of the copernicusmarine registration and that's it? So that we know that users will migrate slowly, no?
There was a problem hiding this comment.
It's not about changing the registration it's about where you put your credentials!
|
Also, about the contribution guide, maybe we will also need to specify a bit more how we want people to interact with it, no? Just saying that we welcome contributions might be too open to interpretation. |
#145) pour the readme in the documentation
#145) pour the readme in the documentation
Fix CMT-26
Fix CMT-25
Fix CMT-17 🥳