Skip to content

Commit aacfeba

Browse files
committed
* '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
2 parents f9d09c6 + cf7e33f commit aacfeba

File tree

16 files changed

+991
-970
lines changed

16 files changed

+991
-970
lines changed

CHANGELOG.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
# Changelog
22

3-
## [Unreleased]
3+
## [2.2.0] - 2024-01-04
4+
5+
- Update application for Python 3.11
6+
- Update dependencies including SQLAlchemy 2
7+
8+
## [2.0.0]
9+
10+
- Switch dependency management to Poetry
11+
- Break into submodules
12+
13+
## [Unknown]
414

515
- New [notebooks](notebooks) showing
616
[usage in Python](notebooks/Corelle-Basic-Usage.ipynb) and building towards

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,16 @@ To build (and continuously watch) the frontend, run `make dev`.
9191
A backend API server will be started and proxied, so you don't have to run
9292
`corelle serve`.
9393

94-
### Installation with Docker
94+
### Testing
9595

96-
Simply install Docker and run `docker-compose up --build` in the root directory.
96+
Corelle contains an extensive set of conformance tests to ensure that it has
97+
GPlates-compatible rotation handling, and to ensure that rotation APIs perform
98+
correctly and performantly in both Python and PostGIS. To run the test suite,
99+
run `make test-docker` in the application directory.
100+
101+
### Running the web app with Docker
102+
103+
Install Docker and run `docker-compose up --build` in the root directory.
97104
This will build the application, install test data, and spin up the development server.
98105

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

106113
- [x] Fix subtle math bugs!
107-
- [ ] On-database cache of rotations (say, at 1 Ma increments?)
108-
- [ ] Return pre-rotated feature datasets (rather than just modern versions)
114+
- [x] On-database cache of rotations (say, at 1 Ma increments?)
115+
- [x] Return pre-rotated feature datasets (rather than just modern versions)
109116
- [x] Materialized view for split feature datasets
110117
- [x] Allow feature datasets to be listed
111118
- [x] Create a dockerized version

bin/test-docker

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33

44
set -e
55

6+
# Check if we're in a TTY
7+
TTY_FLAG=""
8+
if [ -t 1 ]; then
9+
TTY_FLAG="-it"
10+
fi
11+
612
# Load dotenv if it exists
713
if [ -f .env ]; then
814
set -o allexport
@@ -44,7 +50,7 @@ docker run --rm \
4450
EOF
4551

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

4955
# Stop the database
5056
docker stop corelle-db

0 commit comments

Comments
 (0)