Metadata-Version: 2.1
Name: ufmetadata
Version: 0.0.2
Summary: Urban Flows Observatory (Sheffield) metadata tools
Home-page: https://github.com/Joe-Heffer-Shef/ufmetadata
Author: Joe Heffer
Author-email: j.heffer@sheffield.ac.uk
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# Urban Flows Observatory metadata tools

These are tools and classes to help work with metadata in the [Urban Flows Observatory](https://urbanflows.ac.uk/).

* [ufmetadata](https://github.com/Joe-Heffer-Shef/ufmetadata) on Github
* [ufmetadata](https://pypi.org/project/ufmetadata/) on PyPi

## Installation

### Using Python virtual environments

Create a `venv`:

```bash
$ python -m venv my_environment
$ pip install ufmetadata
```

### Using Conda

Create a Conda environment and use pip to install the package from the repository:

```bash
$ conda env create --name my_environment --file environment.yml
```

...where `environment.yml` contains:

```yaml
name: my_environment
channels:
  - defaults
dependencies:
  - python
  - pip
  - pip:
    - ufmetadata
```

## Usage

To view the documentation in Python:

```python
import ufmetadata.assets

help(ufmetadata.assets.Site)
help(ufmetadata.assets.Sensor)
```


