Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Fix rtd #139

Merged
merged 12 commits into from
Nov 6, 2023
Merged
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
8 changes: 4 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -173,13 +173,13 @@ jobs:
run: |
export LD_LIBRARY_PATH="$CONDA_PREFIX/lib:$LD_LIBRARY_PATH"
cd build
./test/test_samurai_lib
./tests/test_samurai_lib

- name: Test with pytest
shell: bash -l {0}
run: |
export LD_LIBRARY_PATH="$CONDA_PREFIX/lib:$LD_LIBRARY_PATH"
cd test
cd tests
pytest -v -s --h5diff

macos-mamba:
Expand Down Expand Up @@ -224,5 +224,5 @@ jobs:
- name: Run tests
shell: bash -l {0}
run: |
./build/test/test_samurai_lib
cd test; pytest --h5diff
./build/tests/test_samurai_lib
cd tests; pytest --h5diff
20 changes: 10 additions & 10 deletions .github/workflows/schedule.yml
Original file line number Diff line number Diff line change
Expand Up @@ -156,13 +156,13 @@ jobs:
- name: Unix test
if: runner.os != 'Windows'
run: |
./build/test/Release/test_samurai_lib
cd test; pytest --h5diff
./build/tests/Release/test_samurai_lib
cd tests; pytest --h5diff
- name: Windows test
if: runner.os == 'Windows'
run: |
.\build\test\Release\test_samurai_lib
# cd test; pytest -s --h5diff
.\build\tests\Release\test_samurai_lib
# cd tests; pytest -s --h5diff

#
# Check vcpkg build
Expand Down Expand Up @@ -258,13 +258,13 @@ jobs:
- name: Unix test
if: runner.os != 'Windows'
run: |
./build/test/Release/test_samurai_lib
cd test; pytest --h5diff
./build/tests/Release/test_samurai_lib
cd tests; pytest --h5diff
- name: Windows test
if: runner.os == 'Windows'
run: |
.\build\test\Release\test_samurai_lib
cd test; pytest -s --h5diff
.\build\tests\Release\test_samurai_lib
cd tests; pytest -s --h5diff

#
# Check windows build using mamba
Expand Down Expand Up @@ -308,5 +308,5 @@ jobs:
- name: Windows test
shell: bash -l {0}
run: |
./build/test/Release/test_samurai_lib
cd test; pytest -s --h5diff
./build/tests/Release/test_samurai_lib
cd tests; pytest -s --h5diff
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
hooks:
- id: check-added-large-files
# - id: check-added-large-files
- id: check-case-conflict
- id: end-of-file-fixer
- id: trailing-whitespace
Expand Down
12 changes: 11 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,12 @@
version: 2

build:
os: "ubuntu-20.04"
tools:
python: "mambaforge-22.9"

sphinx:
configuration: docs/source/conf.py

conda:
file: doc/environment.yml
environment: docs/environment.yml
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ if(BUILD_BENCHMARKS)
endif()

if(BUILD_TESTS)
add_subdirectory(test)
add_subdirectory(tests)
endif()

if(BUILD_DEMOS)
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions doc/environment.yml → docs/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ channels:

dependencies:
- breathe
- sphinx_rtd_theme
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
37 changes: 11 additions & 26 deletions doc/source/index.rst → docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _topics-index:

===============================
Samurai |version| documentation
===============================
========================
|project| documentation
========================

The main goal of |project| is to provide a new data structure based on intervals and algebra of sets to handle efficiently adaptive mesh refinement methods based on a cartesian grid. Such an approach has to be versatile enough to handle both AMR and multi-resolution methods.

Expand All @@ -20,25 +20,10 @@ In order to improve the efficiency of the tree / space-filling curve, the propos

SAMURAI: Structured Adaptive mesh and MUlti-Resolution based on Algebra of Intervals.

.. toctree::
:caption: Table of contents
:hidden:

Test cases
========
.. toctree::
:caption: Test cases
:hidden:

LBM/test_cases


Tutorial
========

.. toctree::
:caption: Tutorial
:hidden:
:maxdepth: 1

tutorial/interval
tutorial/field
Expand All @@ -60,23 +45,23 @@ Tutorial

.. :doc:`tutorial/1d_burgers_amr`

Reference
=========
.. toctree::
:caption: Test cases
:maxdepth: 1

LBM/test_cases

.. toctree::
:caption: Reference
:hidden:
:maxdepth: 2

reference/subset

.. :doc:`reference/subset`

API reference
=============

.. toctree::
:caption: API reference
:hidden:
:maxdepth: 2

api/algorithm
api/interval
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.