### Manual Installation with Pip

Source: https://github.com/dida-do/eurocropsml/blob/main/CONTRIBUTING.md

Installs an editable version of the eurocropsml package and development dependencies manually using pip.

```console
$ pip install -e '.[dev]'
```

--------------------------------

### Install EuroCropsML with Development Dependencies

Source: https://github.com/dida-do/eurocropsml/blob/main/CONTRIBUTING.md

Installs an editable version of the eurocropsml package along with all its development dependencies using the Makefile.

```console
$ make install
```

--------------------------------

### Install EuroCropsML Package

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/starting.md

Install the eurocropsml package using pip. It is recommended to perform this installation within a virtual environment.

```console
python -Im pip install eurocropsml
```

--------------------------------

### Get Help for eurocropsml CLI

Source: https://github.com/dida-do/eurocropsml/blob/main/README.md

Use the eurocropsml-cli --help command to display available commands and options for the command-line interface.

```console
eurocropsml-cli --help
```

--------------------------------

### Get Help for EuroCropsML Datasets CLI

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/dataset.md

Use this command to display help information for the eurocropsml-cli datasets eurocrops command, which is used for data preprocessing.

```console
$ eurocropsml-cli datasets eurocrops --help
```

--------------------------------

### Apply Code Formatting and Linting with Makefile

Source: https://github.com/dida-do/eurocropsml/blob/main/CONTRIBUTING.md

Runs automated code formatting and linting to ensure code quality and adherence to style guides.

```console
$ make format lint
```

--------------------------------

### Clone EuroCropsML Repository

Source: https://github.com/dida-do/eurocropsml/blob/main/CONTRIBUTING.md

Use this command to get an up-to-date checkout of the eurocropsml repository.

```console
$ git clone https://github.com/dida-do/eurocropsml.git
```

--------------------------------

### Python Function with Type Annotations and Docstring

Source: https://github.com/dida-do/eurocropsml/blob/main/CONTRIBUTING.md

Example of a Python function demonstrating type annotations and Google-style docstrings. Ensure all public interfaces are documented.

```python
def function_with_type_annotations(param1: int, param2: str) -> bool:
    """Example function with type annotations.

    An optional more detailed description of the function behavior.

    Args:
        param1: The first parameter.
        param2: The second parameter.
    Returns:
        The return value. True for success, False otherwise.
    """
    ...
```

--------------------------------

### Get Data for a Specific Country Configuration

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/examples.md

Use this command to initiate the data acquisition process for a country using a specified configuration file. Ensure the configuration file is correctly set up for the target country.

```console
$ eurocropsml-cli acquisition eurocrops get-data cfg=eurocrops_country
```

--------------------------------

### Set Custom Data Download Directory

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/examples.md

Set the EUROCROPS_DATA_DIR environment variable to specify an absolute path for downloading data. This is useful when EuroCropsML is installed as a dependency in another project.

```bash
$ export EUROCROPS_DATA_DIR=<absolute-path-to-data-directory>

$ eurocropsml-cli datasets eurocrops download
```

--------------------------------

### Get Data for a Specific Country with Custom Month Filter

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/examples.md

This command allows fetching data for a specific country while applying custom filters, such as selecting data only for January. The configuration for the country and the specific parameters to override are provided via the CLI.

```console
$ eurocropsml-cli acquisition eurocrops get-data cfg=estonia cfg.country_config.months="[1,1]"
```

--------------------------------

### Adjust Cloudy Observation Thresholds

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/examples.md

Customize the lower and upper thresholds for classifying Sentinel-2 observations as cloudy or non-cloudy. This example sets the lower bound to 0.04 and the upper bound to 0.2 for band 4.

```console
$ eurocropsml-cli datasets eurocrops <COMMAND> preprocess.band4_t1=0.04 preprocess.band4_t2=0.2
```

--------------------------------

### Select Custom Preprocessing Configuration

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/examples.md

When multiple preprocessing customizations are needed, create a new custom configuration file (e.g., custom_config.yaml) and select it via the command line.

```console
$ eurocropsml-cli datasets eurocrops <COMMAND> preprocess=custom_config
```

--------------------------------

### Display Available Makefile Commands

Source: https://github.com/dida-do/eurocropsml/blob/main/CONTRIBUTING.md

Lists all available commands configured in the project's Makefile.

```console
$ make help
```

--------------------------------

### Show Acquisition Subcommand Help

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/dataset.md

Display help for the acquisition subcommand of the eurocropsml-cli. This is useful for understanding acquisition-specific options.

```console
$ eurocropsml-cli acquisition eurocrops --help
```

--------------------------------

### Show eurocropsml Dataset Configuration

Source: https://github.com/dida-do/eurocropsml/blob/main/README.md

Display the current default configuration for the eurocropsml dataset CLI.

```console
eurocropsml-cli datasets eurocrops config
```

--------------------------------

### Run Test Suite with Makefile

Source: https://github.com/dida-do/eurocropsml/blob/main/CONTRIBUTING.md

Executes the project's test suite against multiple Python versions using the Makefile.

```console
$ make test
```

--------------------------------

### Download EuroCropsML Dataset

Source: https://github.com/dida-do/eurocropsml/blob/main/README.md

Download the EuroCropsML dataset using the CLI based on the current configuration.

```console
eurocropsml-cli datasets eurocrops download
```

--------------------------------

### Python Class with Docstring and Attributes

Source: https://github.com/dida-do/eurocropsml/blob/main/CONTRIBUTING.md

Illustrates a Python class docstring following Google style, including sections for attributes, arguments, and multi-line descriptions. Use for documenting class attributes and initialization parameters.

```python
class ExampleClass(object):
    """The summary line for a class docstring should fit on one line.

    If the class has public attributes, they may be documented here in an ``Attributes`` section and follow the same formatting as a function's ``Args`` section. 

    Attributes:
        attr1: Description of `attr1`.
        attr2: Description of `attr2`.

    Args:
        param1: Description of `param1`.
        param2: Description of `param2`.
            Multiple lines are supported as well.
        param3: Description of `param3`.

    """

    def __init__(self, param1: str, param2: int, param3: float):
        ...

```

--------------------------------

### Run Tox Environments for Multiple Python Versions

Source: https://github.com/dida-do/eurocropsml/blob/main/CONTRIBUTING.md

Uses tox to run tests against specified Python versions (e.g., 3.10 and 3.11).

```console
$ tox run -e py310,py311
```

--------------------------------

### Acquire Sentinel-1 Data with Operational Mode

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/examples.md

This command shows how to acquire Sentinel-1 data and additionally specify an operational mode, such as 'EW'. Ensure to consult the configuration documentation for valid operational modes.

```console
$ eurocropsml-cli acquisition eurocrops <COMMAND> cfg.country_config.satellite="S1" +cfg.country_config.operational_mode="EW"
```

--------------------------------

### Git Graph Visualization

Source: https://github.com/dida-do/eurocropsml/blob/main/CONTRIBUTING.md

Visual representation of the git branching and merging strategy used in the project. This helps understand the flow of feature development and integration into the main branch.

```mermaid
%%{init: { 'theme': 'base', 'gitGraph': {'showCommitLabel': false}} }%%
gitGraph
  commit
  commit
  branch 42-some-feature
  checkout 42-some-feature
  commit
  commit
  checkout main
  merge 42-some-feature
  commit
  branch 43-another-feature
  checkout 43-another-feature
  commit
  commit
  commit
  checkout main
  merge 43-another-feature
  commit

```

--------------------------------

### Citation - BibTeX Dataset

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/license.md

BibTeX citation for the EuroCropsML dataset on Zenodo.

```bibtex
@misc{reuss_macdonald_eurocropsml_zenodo_2024,
  author = {Reuss, Joana and Macdonald, Jan},
  title = {EuroCropsML},
  year = {2024},
  publisher = {Zenodo},
  doi = {10.5281/zenodo.10629609},
  url = {https://doi.org/10.5281/zenodo.10629609}
}
```

--------------------------------

### Write Assertions for Tests

Source: https://github.com/dida-do/eurocropsml/blob/main/CONTRIBUTING.md

Use the 'actual == expected' format for assertions in Python tests for consistency. Ensure important attributes and values are checked.

```python
x = f(...)

assert x.important_attribute == 42
assert x.another_attribute == "foobar"
```

--------------------------------

### Citation - Plain Text Dataset

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/license.md

Plain text citation for the EuroCropsML dataset on Zenodo.

```text
Reuss, J., & Macdonald, J. (2024). EuroCropsML [dataset]. Zenodo. https://doi.org/10.5281/zenodo.10629609
```

--------------------------------

### Collect Data for Estonia

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/dataset.md

Execute the data collection process for Estonia using a predefined configuration file. This command fetches Sentinel-2 data for the specified region.

```console
$ eurocropsml-cli acquisition eurocrops get-data cfg=estonia
```

--------------------------------

### Specify Custom EO-Data Directory

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/examples.md

Use the `eodata_dir` argument in the `eurocropsml-cli` to specify a custom directory for EO-data tiles. This overrides the default '/eodata' location.

```bash
$ eurocropsml-cli acquisition eurocrops get-data +cfg.eodata_dir="personal_eodata_dir"
```

--------------------------------

### Pre-process Sentinel-1 Data

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/examples.md

Set the 'satellite' variable to 'S1' to pre-process Sentinel-1 data. This can be done directly in the default.yaml configuration file or via the command line.

```console
$ eurocropsml-cli datasets eurocrops preprocess preprocess.satellite="S1"
```

--------------------------------

### Run Tests Manually with Pytest

Source: https://github.com/dida-do/eurocropsml/blob/main/CONTRIBUTING.md

Executes tests against the currently active Python version using pytest.

```console
$ python -m pytest
```

--------------------------------

### Acquire Sentinel-1 Data

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/examples.md

To obtain Sentinel-1 data, change the 'satellite' variable to 'S1' in the country's configuration file or via the command line. This command demonstrates how to set the satellite to S1.

```console
$ eurocropsml-cli acquisition eurocrops <COMMAND> cfg.country_config.satellite="S1"
```

--------------------------------

### Citation - BibTeX Article

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/license.md

BibTeX citation for the Scientific Data article about the EuroCropsML dataset.

```bibtex
@article{reuss_macdonald_eurocropsml_nsd_2025,
  author = {Reuss, Joana and Macdonald, Jan and Becker, Simon and Richter, Lorenz and K{"o}rner, Marco},
  title = {The EuroCropsML time series benchmark dataset for few-shot crop type classification in Europe},
  journal = {Scientific Data},
  year = {2025},
  volume = {12},
  note = {664},
  issn = {2052-4463},
  doi = {10.1038/s41597-025-04952-7},
  url = {https://doi.org/10.1038/s41597-025-04952-7}
}
```

--------------------------------

### Citation - Plain Text Article

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/license.md

Plain text citation for the Scientific Data article about the EuroCropsML dataset.

```text
Reuss, J., Macdonald, J., Becker, S. et al. The EuroCropsML time series benchmark dataset for few-shot crop type classification in Europe. Sci Data 12, 664 (2025). https://doi.org/10.1038/s41597-025-04952-7
```

--------------------------------

### Disable Cloudy Observation Filtering

Source: https://github.com/dida-do/eurocropsml/blob/main/docs/examples.md

Use this command to disable the removal of cloudy observations in the dataset preprocessing pipeline.

```console
$ eurocropsml-cli datasets eurocrops <COMMAND> preprocess.filter_clouds=false
```

--------------------------------

### Write Semantic Newlines in Markdown

Source: https://github.com/dida-do/eurocropsml/blob/main/CONTRIBUTING.md

Use semantic newlines in Markdown documentation files, where each sentence is on a new line. This applies to reStructuredText as well.

```markdown
This is a sentence.
This is another sentence.
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.