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

Docs update: passing data into expressions #2927

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
05f25ba
master branch will be 5.1.1 not 5.2.0
dschwoerer Oct 18, 2023
0994fc2
Merge pull request #2784 from boutproject/master-version
ZedThree Oct 20, 2023
4c4ef70
CI: Replace pip script with requirements.txt
ZedThree Oct 30, 2023
9549152
Merge pull request #2794 from boutproject/bump-pip-packages
ZedThree Nov 6, 2023
35a85b1
Set oversubscribe flags for openmpi 5
dschwoerer Nov 6, 2023
37e20c0
Merge pull request #2800 from boutproject/ci-openmpi-5
ZedThree Nov 7, 2023
bba2ef2
Bump actions/setup-python from 4 to 5
dependabot[bot] Dec 11, 2023
ca7f600
Bump externalpackages/boutdata from `908a4c2` to `a043a2b`
dependabot[bot] Dec 21, 2023
abc5f34
Bump externalpackages/googletest from `829c199` to `dddb219`
dependabot[bot] Dec 28, 2023
84e9456
Merge pull request #2819 from boutproject/dependabot/github_actions/a…
dschwoerer Jan 3, 2024
8fb1ac1
Merge pull request #2830 from boutproject/dependabot/submodules/exter…
bendudson Jan 3, 2024
d5d65c8
Merge pull request #2827 from boutproject/dependabot/submodules/exter…
bendudson Jan 3, 2024
46f5c42
Remove propietary data
dschwoerer Jan 5, 2024
3e5240b
Merge pull request #2832 from boutproject/remove-nonfree-master
bendudson Jan 6, 2024
73fb776
Do not excessively bump googletest
dschwoerer Jan 12, 2024
aeb0897
Merge pull request #2836 from boutproject/dependeabot
ZedThree Jan 12, 2024
62e6fdc
Add warnings about SUNDIALS versions <4
Steven-Roberts Jan 19, 2024
4a9d33c
Bump actions/cache from 3 to 4
dependabot[bot] Jan 22, 2024
8da5949
Bump ZedThree/clang-tidy-review from 0.14.0 to 0.17.0
dependabot[bot] Jan 22, 2024
394ef15
Merge pull request #2845 from boutproject/dependabot/github_actions/a…
ZedThree Jan 25, 2024
18b22ad
Merge pull request #2846 from boutproject/dependabot/github_actions/Z…
bendudson Jan 25, 2024
79601f9
Merge pull request #2840 from Steven-Roberts/sundials-warning
bendudson Jan 26, 2024
ff80d43
Bump codecov/codecov-action from 3 to 4
dependabot[bot] Feb 5, 2024
98e7c8e
Bump externalpackages/googletest from `dddb219` to `b75ecf1`
dependabot[bot] Feb 12, 2024
114d94b
Merge pull request #2860 from boutproject/dependabot/github_actions/c…
ZedThree Feb 14, 2024
9486054
Merge pull request #2864 from boutproject/dependabot/submodules/exter…
bendudson Feb 14, 2024
73e6e1e
Bump externalpackages/boutdata from `a043a2b` to `9e603a2`
dependabot[bot] Feb 19, 2024
7fb4f49
Merge pull request #2866 from boutproject/dependabot/submodules/exter…
bendudson Feb 23, 2024
81b8ac2
Bump externalpackages/googletest from `b75ecf1` to `e4fdb87`
dependabot[bot] Mar 4, 2024
3d9e940
Merge pull request #2877 from boutproject/dependabot/submodules/exter…
bendudson Mar 7, 2024
e7f2d02
Bump externalpackages/boutdata from `9e603a2` to `cd0bc40`
dependabot[bot] Mar 11, 2024
f604fa3
Bump externalpackages/googletest from `e4fdb87` to `b479e7a`
dependabot[bot] Mar 11, 2024
0bf97e9
Merge pull request #2879 from boutproject/dependabot/submodules/exter…
bendudson Mar 11, 2024
cbeff91
Merge pull request #2880 from boutproject/dependabot/submodules/exter…
bendudson Mar 11, 2024
80aba7c
Bump ZedThree/clang-tidy-review from 0.17.0 to 0.18.0
dependabot[bot] Apr 1, 2024
8b52e40
Fix name of PVODE Config file
dschwoerer Apr 17, 2024
77eede4
Merge pull request #2903 from boutproject/pvcode-cmake
ZedThree Apr 19, 2024
6d60613
Bump externalpackages/googletest from `b479e7a` to `5a37b51`
dependabot[bot] Apr 22, 2024
abe9923
Merge pull request #2897 from boutproject/dependabot/github_actions/Z…
bendudson Apr 24, 2024
a02cfd6
Merge pull request #2906 from boutproject/dependabot/submodules/exter…
bendudson Apr 24, 2024
c482ac3
Bump externalpackages/boututils from `433995f` to `6c22995`
dependabot[bot] May 6, 2024
2522585
Bump externalpackages/googletest from `5a37b51` to `33af80a`
dependabot[bot] May 13, 2024
644bdea
Bump ZedThree/clang-tidy-review from 0.18.0 to 0.19.0
dependabot[bot] May 13, 2024
772c7ad
Merge pull request #2911 from boutproject/dependabot/submodules/exter…
bendudson May 16, 2024
dc3d160
Merge pull request #2912 from boutproject/dependabot/submodules/exter…
bendudson May 16, 2024
c193e73
Merge pull request #2913 from boutproject/dependabot/github_actions/Z…
bendudson May 16, 2024
adaa89b
Update documentation for Passing data into expressions
tbody-cfs Jun 20, 2024
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
1 change: 1 addition & 0 deletions .ci_fedora.sh
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ else
. /etc/profile.d/modules.sh
module load mpi/${1}-x86_64
export OMPI_MCA_rmaps_base_oversubscribe=yes
export PRTE_MCA_rmaps_default_mapping_policy=:oversubscribe
export TRAVIS=true
export FLEXIBLAS=NETLIB
cd
Expand Down
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version: 2
updates:
- package-ecosystem: "gitsubmodule"
schedule:
interval: "daily"
interval: "weekly"
directory: "/"

- package-ecosystem: "pip"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/clang-tidy-review.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
submodules: true

- name: Run clang-tidy
uses: ZedThree/clang-tidy-review@v0.14.0
uses: ZedThree/clang-tidy-review@v0.19.0
id: review
with:
build_dir: build
Expand All @@ -46,4 +46,4 @@ jobs:
-DBOUT_UPDATE_GIT_SUBMODULE=OFF

- name: Upload clang-tidy fixes
uses: ZedThree/clang-tidy-review/upload@v0.14.0
uses: ZedThree/clang-tidy-review/upload@v0.19.0
6 changes: 3 additions & 3 deletions .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
fetch-depth: 0
submodules: true
- name: Set up Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
- name: Install dependencies
run: python -m pip install --upgrade pip &&
pip install --upgrade build &&
Expand Down Expand Up @@ -62,7 +62,7 @@ jobs:
fetch-depth: 0
submodules: true
- name: Set up Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
- name: Install dependencies
run: python -m pip install --upgrade pip &&
pip install --upgrade build &&
Expand Down Expand Up @@ -111,7 +111,7 @@ jobs:
fetch-depth: 0
submodules: true
- name: Set up Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
- name: Install dependencies
run: python -m pip install --upgrade pip &&
pip install --upgrade build &&
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ jobs:
OMP_NUM_THREADS: ${{ matrix.config.omp_num_threads }}
PYTHONPATH: ${{ github.workspace }}/tools/pylib
OMPI_MCA_rmaps_base_oversubscribe: yes
PRTE_MCA_rmaps_default_mapping_policy: ":oversubscribe"
MPIRUN: mpiexec -np
strategy:
fail-fast: true
Expand Down Expand Up @@ -179,18 +180,17 @@ jobs:
with:
submodules: true

- uses: actions/setup-python@v4
- uses: actions/setup-python@v5
with:
python-version: '3.x'

- name: Install pip packages
run: |
./.pip_install_for_ci.sh 'cython~=0.29' 'netcdf4~=1.5' 'sympy~=1.5' 'gcovr' 'cmake' zoidberg fastcov
# Add the pip install location to the runner's PATH
echo ~/.local/bin >> $GITHUB_PATH
python -m pip install --upgrade pip setuptools
python -m pip install -r requirements.txt

- name: Cache SUNDIALS build
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: /home/runner/local
key: bout-sundials-${{ matrix.config.os }}${{ matrix.config.build_petsc }}
Expand Down Expand Up @@ -218,7 +218,7 @@ jobs:

- name: Upload coverage
if: ${{ matrix.config.name == 'Coverage' }}
uses: codecov/codecov-action@v3
uses: codecov/codecov-action@v4

Fedora:
# This is its own job as it doesn't use most of the steps of the
Expand Down
20 changes: 0 additions & 20 deletions .pip_install_for_ci.sh

This file was deleted.

2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ endif()
# Set the version here, strip any extra tags to use in `project`
# We try to use git to get a full description, inspired by setuptools_scm
set(_bout_previous_version "5.1.0")
set(_bout_next_version "5.2.0")
set(_bout_next_version "5.1.1")
execute_process(
COMMAND "git" describe --tags --match=v${_bout_previous_version}
COMMAND sed -e s/${_bout_previous_version}-/${_bout_next_version}.dev/ -e s/-/+/
Expand Down
4 changes: 4 additions & 0 deletions cmake/FindSUNDIALS.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,10 @@ if (SUNDIALS_INCLUDE_DIR)
set(SUNDIALS_VERSION "${SUNDIALS_VERSION_MAJOR}.${SUNDIALS_VERSION_MINOR}.${SUNDIALS_VERSION_PATCH}" CACHE STRING "SUNDIALS version")
endif()

if("${SUNDIALS_VERSION_MAJOR}" LESS 4)
message(WARNING "SUNDIALS versions <4 are depricated and will not be supported in the next release")
endif()

if (SUNDIALS_DEBUG)
message(STATUS "[ ${CMAKE_CURRENT_LIST_FILE}:${CMAKE_CURRENT_LIST_LINE} ] "
" SUNDIALS_VERSION = ${SUNDIALS_VERSION}")
Expand Down
Binary file removed examples/shear-alfven-wave/orig_test.idl.dat
Binary file not shown.
Binary file removed examples/uedge-benchmark/result_080917.idl
Binary file not shown.
Binary file removed examples/uedge-benchmark/ue_bmk.idl
Binary file not shown.
2 changes: 1 addition & 1 deletion externalpackages/PVODE/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ write_basic_package_version_file(
)

install(EXPORT PVODETargets
FILE PVODETargets.cmake
FILE PVODEConfig.cmake
NAMESPACE PVODE::
DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/PVODE"
)
Expand Down
2 changes: 1 addition & 1 deletion externalpackages/boutdata
2 changes: 1 addition & 1 deletion externalpackages/googletest
Submodule googletest updated 59 files
+0 −43 .github/workflows/gtest-ci.yml
+1 −0 .gitignore
+17 −0 BUILD.bazel
+9 −0 CMakeLists.txt
+1 −0 CONTRIBUTORS
+61 −0 MODULE.bazel
+14 −12 WORKSPACE
+35 −0 WORKSPACE.bzlmod
+6 −4 ci/linux-presubmit.sh
+2 −1 ci/macos-presubmit.sh
+2 −2 ci/windows-presubmit.bat
+15 −5 docs/advanced.md
+32 −3 docs/gmock_cook_book.md
+2 −0 docs/gmock_for_dummies.md
+17 −18 docs/primer.md
+7 −3 docs/reference/testing.md
+33 −0 fake_fuchsia_sdk.bzl
+4 −3 googlemock/CMakeLists.txt
+27 −9 googlemock/include/gmock/gmock-actions.h
+90 −89 googlemock/include/gmock/gmock-matchers.h
+4 −3 googlemock/include/gmock/gmock-more-actions.h
+1 −0 googlemock/include/gmock/gmock.h
+8 −6 googlemock/include/gmock/internal/gmock-internal-utils.h
+4 −4 googlemock/include/gmock/internal/gmock-port.h
+3 −2 googlemock/src/gmock-internal-utils.cc
+2 −1 googlemock/src/gmock-spec-builders.cc
+9 −0 googlemock/test/gmock-matchers-comparisons_test.cc
+39 −1 googlemock/test/gmock-more-actions_test.cc
+9 −0 googlemock/test/gmock_link_test.h
+1 −1 googletest/CMakeLists.txt
+4 −0 googletest/cmake/Config.cmake.in
+3 −1 googletest/cmake/internal_utils.cmake
+1 −1 googletest/include/gtest/gtest-assertion-result.h
+4 −4 googletest/include/gtest/gtest-death-test.h
+4 −4 googletest/include/gtest/gtest-param-test.h
+35 −21 googletest/include/gtest/gtest-printers.h
+65 −61 googletest/include/gtest/gtest-typed-test.h
+32 −14 googletest/include/gtest/gtest.h
+24 −23 googletest/include/gtest/internal/gtest-death-test-internal.h
+7 −1 googletest/include/gtest/internal/gtest-filepath.h
+25 −63 googletest/include/gtest/internal/gtest-internal.h
+78 −76 googletest/include/gtest/internal/gtest-param-util.h
+2 −0 googletest/include/gtest/internal/gtest-port-arch.h
+51 −20 googletest/include/gtest/internal/gtest-port.h
+18 −16 googletest/src/gtest-death-test.cc
+28 −16 googletest/src/gtest-internal-inl.h
+34 −19 googletest/src/gtest-port.cc
+159 −109 googletest/src/gtest.cc
+1 −0 googletest/test/googletest-color-test.py
+39 −37 googletest/test/googletest-death-test-test.cc
+15 −0 googletest/test/googletest-json-output-unittest.py
+4 −1 googletest/test/googletest-options-test.cc
+0 −5 googletest/test/googletest-output-test-golden-lin.txt
+52 −44 googletest/test/gtest_environment_test.cc
+3 −0 googletest/test/gtest_json_test_utils.py
+1 −3 googletest/test/gtest_repeat_test.cc
+18 −26 googletest/test/gtest_unittest.cc
+9 −6 googletest/test/gtest_xml_output_unittest.py
+14 −8 googletest_deps.bzl
7 changes: 4 additions & 3 deletions manual/sphinx/user_docs/advanced_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -430,9 +430,10 @@ solver. Currently, BOUT++ also supports the SUNDIALS solvers CVODE, IDA
and ARKODE which are available from
https://computation.llnl.gov/casc/sundials/main.html.

.. note:: BOUT++ currently supports SUNDIALS > 2.6, up to 5.4.0 as of
September 2020. It is advisable to use the highest possible
version
.. note:: BOUT++ currently supports SUNDIALS > 2.6, up to 6.7.0 as of
January 2024. It is advisable to use the highest possible
version. Support for SUNDIALS versions < 4 will be removed
in the next release.

The full installation guide is found in the downloaded ``.tar.gz``,
but we will provide a step-by-step guide to install it and make it
Expand Down
20 changes: 9 additions & 11 deletions manual/sphinx/user_docs/variable_init.rst
Original file line number Diff line number Diff line change
Expand Up @@ -328,22 +328,20 @@ to ``generate`` in the ``Context`` object.

Field3D shear = ...; // Value calculated in BOUT++

FieldFactory factory(mesh);
auto gen = factory->parse("model:viscosity");
Options& model_options = options["model"];
auto str = model_options["viscosity"].doc("Viscosity").as<std::string()>;

auto gen = FieldFactory::get()->parse(str, &model_options);

Field3D viscosity;
viscosity.allocate();

BOUT_FOR(i, viscosity.region("RGN_ALL")) {
viscosity[i] = gen->generate(bout::generator::Context(i, CELL_CENTRE, mesh, 0.0)
.set("shear", shear[i]));

BOUT_FOR(i, viscosity.getRegion("RGN_ALL")) {
viscosity[i] = gen->generate(bout::generator::Context().set("shear", shear[i]));
}

Note that the ``Context`` constructor takes the index, the cell
location (e.g. staggered), a mesh, and then the time (set to 0.0
here). Additional variables can be ``set``, "shear" in this case. In
the input options file (or command line) the viscosity could now be a
function of ``{shear}``
In the input options file (or command line) the viscosity can now be written as
a function of ``{shear}``

.. code-block:: cfg

Expand Down
6 changes: 4 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Jinja2>=2.11.3
numpy>=1.14.1
scipy>=1.0.0
netcdf4>=1.3.1
netcdf4~=1.6.0
matplotlib>=2.0.0
Cython>=0.29.0
Cython~=3.0.0
boututils~=0.2.1
boutdata~=0.2.1
Binary file not shown.
2 changes: 1 addition & 1 deletion tools/pylib/_boutpp_build/backend.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def getversion():
return version

_bout_previous_version = "v5.1.0"
_bout_next_version = "v5.2.0"
_bout_next_version = "v5.1.1"

try:
try:
Expand Down