Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/)
and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added
- Added docker container for development. Contributed by @AgentOxygen

### Fixed
- Fixed numpy build dependency. Contributed by @AgentOxygen

## [2.1.1]

Expand Down
9 changes: 9 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
FROM continuumio/miniconda3:main

WORKDIR /project

COPY . .

RUN conda env update -n base --file environment.yml --prune

RUN python -m pip install --use-pep517 --no-build-isolation -e .
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,17 @@ find geo_autoRIFT -iname "*.h" -exec clang-format -i {} \;
find geo_autoRIFT -iname "*.cpp" -exec clang-format -i {} \;
```

### (Optional) Development using Docker

A containerized development environment with the necessary dependencies can be created using Docker. The following commands can be used to build the container and enter it:

```
docker built --rm -t autorift .
docker run -v .:/project -it autorift /bin/bash
```

Note that `/project` is the working directory inside the container. The argument `-v .:/project` binds the local source code directory to the live installation inside the container.

## Usage

> [!WARNING]
Expand Down
Binary file not shown.
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["setuptools>=68", "wheel", "numpy>=1.26"]
build-backend = "setuptools.build_meta"