Repo structure

[barneydobson]

Description

I've mainly just repurposed what was used in WSIMOD.

• CONTRIBUTING
• AUTHORS
• CODE_OF_CONDUCT
• HISTORY
• LICENSE
• Use conda by default - see quote below? Though the testing has been fine so far and it tests on ubuntu, macos and windows. Is there a simple way to implement this that is also compatible with the pyproject.toml installation?

Since this package depends on geospatial packages, using conda (mamba, or micromamba) is recommended for development and users, too. There are many discussions about this on the internet, but the main reason is that many of the these geospatial packages depend on non-python libraries that can be tricky to install on different platforms. Using conda solves this issue since conda packages are pre-compiled and optimized for different platforms. So, it makes managing the dependencies easier and codes may even run faster, too.

From #24 by @cheginit

Fixes #24

[dalonsoa]

LGTM!

Conda/Mamba does not support pyproject.toml. You will need write an environment file for that (or more than one for normal users and developers).

I've just come across Pixi. I've never tried to use it but I know they are working on implementing support for pyroject.toml. Might be worth to have a look from time to time.

[cheginit]

Why you started out with conda then switched to pip?

Regardless, I think using micromamba makes things much more straightforward. Installation is very easy and is much, much faster than using conda since it's based on mamba.

[barneydobson]

I've been using the pyproject.toml - which I think conda/mamba doesn't use? Does it make sense to just discuss this as part of #113 ? Or is it different?

[cheginit]

@barneydobson @dalonsoa I've used pixi for a while. It's a very exciting up-and-coming project and their road map is great. They are planning to use uv instead of pip which makes it even more exciting. However, it's still in early stages and does not support all use cases. It's definitely something to keep an eye on, though.

My current workflow is using micromamba for development and nox for all other stuff. This requires having two env files: environment.yml for CI testing only, and environment-dev.yml for development purposes. I usually put them under a folder called ci/requirements. So, for development purposes, the command becomes:

micromamba env create -f ci/requirements/environment-dev.yml
micromamba activate env_name

Then, testing, linting, and type checking becomes just running:

nox

[barneydobson]

@barneydobson @dalonsoa I've used pixi for a while. It's a very exciting up-and-coming project and their road map is great. They are planning to use uv instead of pip which makes it even more exciting. However, it's still in early stages and does not support all use cases. It's definitely something to keep an eye on, though.

My current workflow is using micromamba for development and nox for all other stuff. This requires having two env files: environment.yml for CI testing only, and environment-dev.yml for development purposes. I usually put them under a folder called ci/requirements. So, for development purposes, the command becomes:

micromamba env create -f ci/requirements/environment-dev.yml
micromamba activate env_name

Then, testing, linting, and type checking becomes just running:

nox

Sounds good - referenced in issue #113

[barneydobson]

Merging this as any of the leftovers can be discussed in #113