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

Fixes in docs and HDF5 support #497

Merged
merged 6 commits into from
Feb 8, 2025
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
3 changes: 2 additions & 1 deletion .github/workflows/package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-14, windows-latest]
os: [ubuntu-latest, macos-14, macos-15, windows-latest]
build_type: [Release]
c_compiler: [clang]
python-version: ['3.11']
Expand Down Expand Up @@ -105,6 +105,7 @@ jobs:
python -m cibuildwheel --output-dir wheelhouse
dir wheelhouse
- name: Upload packages
if: github.ref == 'refs/heads/main'
uses: xresloader/upload-to-github-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
14 changes: 11 additions & 3 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ To build `MOOSE` from source, you need `meson`, `ninja`, `pkg-config`, and `pyth
recommend to use Python 3.9 or higher. To build and install with `pip`, you also need `meson-python`.

For platform specific instructions, see:
- Linux: UbuntuBuild.md
- MacOSX: AppleM1Build.md
- Windows: WindowsBuild.md
- Linux: [UbuntuBuild.md](UbuntuBuild.md)
- MacOSX: [AppleM1Build.md](AppleM1Build.md)
- Windows: [WindowsBuild.md](WindowsBuild.md)

Briefly,
1. Build environment: make sure that the following packages are installed on your system.
Expand All @@ -68,6 +68,14 @@ Briefly,
$ pip install git+https://github.com/BhallaLab/moose-core --user
```

This will install the `master` branch of MOOSE. If you want a specific fork/branch, modify the address:

```
$ pip install git+https://github.com/subhacom/moose-core@fix495merge --user
```

will install the fix495merge branch from `subhacom`'s fork of `moose-core`.

## Post installation

You can check that moose is installed and initializes correctly by running:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ https://github.com/BhallaLab/moose-examples.
# Build

To build `pymoose`, follow instructions given in
[INSTALLATION.md](INSTALLATION.md) and for platform specific
[INSTALL.md](INSTALL.md) and for platform specific
information see:
- Linux: [UbuntuBuild.md](UbuntuBuild.md)
- MacOSX: [AppleM1Build.md](AppleM1Build.md)
Expand Down
2 changes: 1 addition & 1 deletion UbuntuBuild.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ conda activate moose
cd moose-core

meson setup --wipe _build --prefix=`pwd`/_build_install -Duse_mpi=false -Dbuildtype=release
ninja -v -C _build
meson compile -v -C _build
meson install -C _build
```

Expand Down
8 changes: 4 additions & 4 deletions WindowsBuild.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ $env:PATH="$env:PATH;C:\Program Files\LLVM\bin"

```
cd moose-core
meson setup --wipe _build -Duse_mpi=false --buildtype=release
ninja -v -C _build
meson setup --wipe _build -Duse_mpi=false --buildtype=release --vsenv
meson compile -vC _build
meson install -C _build
```
*Note: If you want to keep the installation in local folder replace the third command with: `meson setup --wipe _build --prefix={absolute-path} -Duse_mpi=false --buildtype=release` where `absolute-path` is the full path of the folder you want to install it in. You will have to add the `Lib\site-packages` directory within this to your PATH environment variable to make `moose` module visible to Python.*
Expand All @@ -68,7 +68,7 @@ Meson provides many builtin options: https://mesonbuild.com/Builtin-options.html


```
meson setup --wipe _build --prefix=%CD%\\_build_install -Duse_mpi=false -Dbuildtype=debug
meson setup --wipe _build --prefix=%CD%\\_build_install -Duse_mpi=false -Dbuildtype=debug --vsenv
```

You can either use `buildtype` option alone or use the two options `debug` and `optimization` for finer grained control over the build. According to `meson` documentation `-Dbuildtype=debug` will create a debug build with optimization level 0 (i.e., no optimization, passing `-O0 -g` to GCC), `-Dbuildtype=debugoptimized` will create a debug build with optimization level 2 (equivalent to `-Ddebug=true -Doptimization=2`), `-Dbuildtype=release` will create a release build with optimization level 3 (equivalent to `-Ddebug=false -Doptimization=3`), and `-Dbuildtype=minsize` will create a release build with space optimization (passing `-Os` to GCC).
Expand All @@ -91,7 +91,7 @@ is to make a copy of `python3x.lib` named `python3x_d.lib` in the same
directory (`libs`). After that, you can run meson setup as follows:

```
meson setup --wipe _build --prefix=%CD%\\_build_install -Duse_mpi=false --buildtype=debug
meson setup --wipe _build --prefix=%CD%\\_build_install -Duse_mpi=false --buildtype=debug --vsenv
```

and then go through the rest of the steps.
Expand Down
Loading