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

Updated Readme #19

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Updated Readme #19

wants to merge 3 commits into from

Conversation

sirbastiano
Copy link
Collaborator

Update layout readme to make it more compelling

@sirbastiano sirbastiano changed the title commit Updated Readme Aug 2, 2023
Copy link
Collaborator

@GabrieleMeoni GabrieleMeoni left a comment

Choose a reason for hiding this comment

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

Except for the Glossary, I do not like the changes.

  • Hyperlinks are now not working
  • The table of content is more difficult to read
  • Most of the README looks gray and not easy to read

README.md Outdated
<li><a href="#how-to-perform-the-coarse-coregisteration-of-rawgranules">How to perform the coarse coregisteration of Raw_granules</a></li>
<li><a href="#how-to-get-coordinates-of-a-raw-granule-band">How to get the coordinates of a Raw granule band</a></li>
<li><a href="#rawevent-database-metadata">Raw_event: database metadata</a></li>
<li><a href="#export-a-rawgranule-to-tif">Export a Raw_granule to TIF</a></li>
</ul>
</li>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Hyperlinks are broken. Restore them

README.md Outdated Show resolved Hide resolved
| Directory Name | Description | Subdirectories and Contents |
|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
| quickstart | Contains some subdirectories including examples. | - `API demonstration`: A [jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/index.html) to demonstrate PyRawS API. |
| pyraws | Contains the PyRawS package. | - `database`: Various [PyRawS database](#PyRawS-databases) and other databases. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
| pyraws | Contains the PyRawS package. | - `database`: Various [PyRawS database](#PyRawS-databases) and other databases. |
| pyraws | Contains the PyRawS package. | `database`: Various [PyRawS database](#PyRawS-databases) and other databases. |

|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
| quickstart | Contains some subdirectories including examples. | - `API demonstration`: A [jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/index.html) to demonstrate PyRawS API. |
| pyraws | Contains the PyRawS package. | - `database`: Various [PyRawS database](#PyRawS-databases) and other databases. |
| | | - `raw`: Includes the `Raw_event` and `Raw_granule` classes used to model [Sentinel-2 Raw events](#sentinel-2-raw-event) and [Sentinel-2 Raw granules](#sentinel-2-raw-granule). |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
| | | - `raw`: Includes the `Raw_event` and `Raw_granule` classes used to model [Sentinel-2 Raw events](#sentinel-2-raw-event) and [Sentinel-2 Raw granules](#sentinel-2-raw-granule). |
| | | `raw`: Includes the `Raw_event` and `Raw_granule` classes used to model [Sentinel-2 Raw events](#sentinel-2-raw-event) and [Sentinel-2 Raw granules](#sentinel-2-raw-granule). |

| quickstart | Contains some subdirectories including examples. | - `API demonstration`: A [jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/index.html) to demonstrate PyRawS API. |
| pyraws | Contains the PyRawS package. | - `database`: Various [PyRawS database](#PyRawS-databases) and other databases. |
| | | - `raw`: Includes the `Raw_event` and `Raw_granule` classes used to model [Sentinel-2 Raw events](#sentinel-2-raw-event) and [Sentinel-2 Raw granules](#sentinel-2-raw-granule). |
| | | - `l1`: Contains the `L1_event` and `L1_tiles` classes used to model [Sentinel-2 L1C events](#sentinel-2-l1c-event) and [Sentinel-2 L1C tiles](#sentinel-2-l1c-tile). |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
| | | - `l1`: Contains the `L1_event` and `L1_tiles` classes used to model [Sentinel-2 L1C events](#sentinel-2-l1c-event) and [Sentinel-2 L1C tiles](#sentinel-2-l1c-tile). |
| | | `l1`: Contains the `L1_event` and `L1_tiles` classes used to model [Sentinel-2 L1C events](#sentinel-2-l1c-event) and [Sentinel-2 L1C tiles](#sentinel-2-l1c-tile). |

### Data directory
>## Data directory
>>
>>All the data used by PyRawS need to be located in a directory called `data`, containing all >>the different datasets. You can place the `data` directory where you want and update the >>`DATA_PATH` variable in the `sys_cfg.py` file with its path (please, refer to: [Set-up for >>coregistration study](#set-up-for-coregistration-study)).
Copy link
Collaborator

Choose a reason for hiding this comment

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

This part looks gray in the README and difficult to READ. It's this on purpose?

* **Raw_files**: list of [Raw granules](#sentinel-2-raw-granule) (**mandatory**).
* **l1c_files**: list of [L1 tiles](#sentinel-2-l1c-tile) (mandatory if you need L1C data).
* **bbox_list**: dictionary {[Raw useful granules](#raw-useful-granule) : [bounding box list for that granule]}. Set to `None` or leave it **empty** if you do not know the bounding box location.
>* **ID_event**: ID of the event (e.g., volcanic-eruption, wildfire, not-event). All the other >fields of the row are referred to that `Sentinel-2` acquisition.
Copy link
Collaborator

Choose a reason for hiding this comment

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

As above, it looks gray and difficult to read.

**Now, you should be able to use your new database! ⭐️**
<br>

>The creation of a database is not mandatory. However, it is strongly advisable. >Indeed, without creating a database you can still open `Raw data` as described in [Open a Raw >event from path](#open-a-raw-event-from-path). However, some pieces of information such as the [Raw useful granules](#raw-useful-granule) associated to a specific event, the event bounding boxes or the image class can be retrieved only when the database is set-up.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Gray and difficult to read

README.md Outdated
The next code snipped will showcase how to use PyRawS to open the [Raw_event](#sentinel-2-raw-event) `Etna_00` included in the `THRAWS` database. <br> To do that,
To manipulate [Raw events](#sentinel-2-raw-event) objects, `PyRawS` will exploits the `Raw_event` class method `from_database(...)`, which parses the associated `.csv` file located in `PyRawS/database` with no need to specify the `PATH` from the user. To execute the next code snipped, we assume to you have already downloaded and set-up the `THRAWS` database as specificied in [databases compatible with PyRawS](#PyRawS-databases).
As for the method `from_path(...)` described in [Open a Raw event from path](#open-an-raw-event-from-path), you can specify which bands to use. If `bands_list` is not specified, the method `from_database(...)` will return all the bands.
>### A) Open a Raw event from path
Copy link
Collaborator

Choose a reason for hiding this comment

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

Gray and difficult to READ


### Sentinel-2 L1C tile
The `Sentinel-2 L1C tile` is the minimum `L1C` product that can be downloaded.
| Term | Description | Reference |
Copy link
Collaborator

Choose a reason for hiding this comment

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

This table is very nice!

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.

2 participants