Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
* 'main' of https://github.com/UW-Macrostrat/corelle:
  Update README.md
  Update README.md
  Detect whether tests are running in a TTY
  Update changelog
  Get rid of warnings
  All tests pass
  More tests pass
  Updated many tests
  Data importing now works
  Update dependencies and lock packages
  • Loading branch information
davenquinn committed May 29, 2024
2 parents f9d09c6 + cf7e33f commit aacfeba
Show file tree
Hide file tree
Showing 16 changed files with 991 additions and 970 deletions.
12 changes: 11 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# Changelog

## [Unreleased]
## [2.2.0] - 2024-01-04

- Update application for Python 3.11
- Update dependencies including SQLAlchemy 2

## [2.0.0]

- Switch dependency management to Poetry
- Break into submodules

## [Unknown]

- New [notebooks](notebooks) showing
[usage in Python](notebooks/Corelle-Basic-Usage.ipynb) and building towards
Expand Down
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,16 @@ To build (and continuously watch) the frontend, run `make dev`.
A backend API server will be started and proxied, so you don't have to run
`corelle serve`.

### Installation with Docker
### Testing

Simply install Docker and run `docker-compose up --build` in the root directory.
Corelle contains an extensive set of conformance tests to ensure that it has
GPlates-compatible rotation handling, and to ensure that rotation APIs perform
correctly and performantly in both Python and PostGIS. To run the test suite,
run `make test-docker` in the application directory.

### Running the web app with Docker

Install Docker and run `docker-compose up --build` in the root directory.
This will build the application, install test data, and spin up the development server.

You can run a development version by creating a `.env` file containing
Expand All @@ -104,8 +111,8 @@ for auto-rebuilding.
## Todo

- [x] Fix subtle math bugs!
- [ ] On-database cache of rotations (say, at 1 Ma increments?)
- [ ] Return pre-rotated feature datasets (rather than just modern versions)
- [x] On-database cache of rotations (say, at 1 Ma increments?)
- [x] Return pre-rotated feature datasets (rather than just modern versions)
- [x] Materialized view for split feature datasets
- [x] Allow feature datasets to be listed
- [x] Create a dockerized version
Expand Down
8 changes: 7 additions & 1 deletion bin/test-docker
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@

set -e

# Check if we're in a TTY
TTY_FLAG=""
if [ -t 1 ]; then
TTY_FLAG="-it"
fi

# Load dotenv if it exists
if [ -f .env ]; then
set -o allexport
Expand Down Expand Up @@ -44,7 +50,7 @@ docker run --rm \
EOF

# Run the tests
docker run -t --rm --link corelle-db:database corelle /code/bin/run-tests $@
docker run $TTY_FLAG --rm --link corelle-db:database corelle /code/bin/run-tests $@

# Stop the database
docker stop corelle-db
Expand Down
Loading

0 comments on commit aacfeba

Please sign in to comment.