diff --git a/.gitignore b/.gitignore index 79fe60c..ed4849b 100644 --- a/.gitignore +++ b/.gitignore @@ -7,7 +7,7 @@ results/ logs_old/ build/ inference_imagery/ -src/ftw.egg-info/ +src/ftw_tools.egg-info/ *.ckpt *.aux.xml *.gpkg @@ -15,3 +15,4 @@ src/ftw.egg-info/ /results.csv /austria_example_output_full.gpkg /austria_example_output_full.tif +/dist diff --git a/CHANGELOGS.md b/CHANGELOG.md similarity index 79% rename from CHANGELOGS.md rename to CHANGELOG.md index a80eaf2..5364f12 100644 --- a/CHANGELOGS.md +++ b/CHANGELOG.md @@ -1,28 +1,42 @@ -# Changelogs +# Changelog -## Version 1.0.0 (Public Release) +## Model + +### v1 + +- First release + +## CLI + +### 1.1.0 + +- First public release to pypi + +### internal legacy non-pypi releases + +#### Version 1.0.0 (Public Release) - Added Dataset download and Unpacking script. - Using WGET to download the zipped version of the data. - Visualize notebook is updated to display stats about the images. - Updated folder structure in README.md -## Version 1.0.1 (Public Release) +#### Version 1.0.1 (Public Release) - FTW Cli now supports downloading partial datasets (country wise) alongside downloading entire dataset. - Updated FTW Cli to support model training and testing. - `main.py` and `test.py` are removed and merged within the FTW Cli for seamless experimentation. - Configuration files are updated to use the new `ftw` and `ftw_cli` modules. -## Version 1.0.2 (Public Release) +#### Version 1.0.2 (Public Release) - Separate click grouping for model class, which has two separate commands fit and test. Checkout `README.md` for more details. -## Version 1.0.3 (Public Release) +#### Version 1.0.3 (Public Release) - `README.md` is cleaned up to keep instruction simple and easy to use. -## Version 1.0.4 (Public Release) +#### Version 1.0.4 (Public Release) - Added configuration and evaluation script for Full FTW and CC-BY Countries training. - Added tensorboard for monitoring training progress. diff --git a/README.md b/README.md index 62ecf7b..9c9f363 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,13 @@ This repository provides the codebase for working with the [FTW dataset](https:/ You need to install Python 3.9 or later and GDAL with libgdal-arrow-parquet. -As a simple way to install the required software you can use Anaconda/Mamba. +The easiest way to install the fiboa CLI is to run: + +```bash +pip install ftw-tools +``` + +The alternative is to install the required software through Anaconda/Mamba. Set up the environment using the provided `env.yml` file: ### (Ana)conda diff --git a/pyproject.toml b/pyproject.toml index 2f237df..ba2e848 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,12 +3,26 @@ requires = ["setuptools>=61.0"] build-backend = "setuptools.build_meta" [project] -name = "ftw" -version = "0.4" -description = "Fields of The World (FTW) - Codebase" +name = "ftw-tools" +version = "1.1.0" +license = {file = "LICENSE"} +description = "Fields of The World (FTW) Command Line Interface (CLI) for data management, ML processing, and more." +readme = 'README.md' authors = [ - { name = "Your Name", email = "your.email@example.com" } + { name = "Matthias Mohr", email = "matthias@mohr.ws" }, + { name = "Caleb Robinson", email = "Caleb.Robinson@microsoft.com" }, + { name = "Aninda Ghosh", email = "aghosh57@asu.edu" }, + { name = "Chris Holmes", email = "cholmes@tgengine.org" }, + { name = "Snehal Chaudhari", email = "sschaud5@asu.edu" }, + { name = "Hannah Kerner", email = "hkerner@asu.edu" }, ] +classifiers = [ + "Development Status :: 4 - Beta", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", +] + +requires-python = ">= 3.9" dependencies = [ "click", # For CLI functionality "tqdm", # For progress bars @@ -37,6 +51,12 @@ dependencies = [ "fiboa-cli==0.7.0", # For storing data in Fiboa format ] +[project.urls] +Homepage = "https://fieldsofthe.world/" +Repository = "https://github.com/fieldsoftheworld/ftw-baselines.git" +Issues = "https://github.com/fieldsoftheworld/ftw-baselines/issues" +Changelog = "https://github.com/fieldsoftheworld/ftw-baselines/blob/main/CHANGELOG.md" + [project.optional-dependencies] dev = [ "black", # Code formatting tool