snews2 / bemews Goto Github PK

View Code? Open in Web Editor NEW

1.0 7.0 0.0 432 KB

A python module for calculating the Earth-matter Effect. Works standalone or with SNEWPY

License: BSD 3-Clause "New" or "Revised" License

Python 1.16% C++ 97.97% C 0.87%

bemews's Introduction

BEMEWS: Better Earth Matter Effect calculation With SNEWPY

Image by dreamstudio.ai

Description

BEMEWS is a python module for calculating the Earth-matter effect on neutrino flavor transformations. It is a standalone module that SNEWPY uses to compute the Earth-Matter Effect for supernova neutrinos. The BEMEWS_example.py script shows how to use the module in standalone mode. The EarthMatter flavor transformation class in SNEWPY is essentially the same script but with the output options turned off.

Installation

BEMEWS is available as a PyPI package and can be installed using

pip install BEMEWS

As of mid-August 2024, installation with pip is only available for Mac users.

If you need or wish to manually install BEMEWS, you can follow the instructions below:

You will need the packages python-devel (in Linux), pybind11, and setuptools
Modify setup.py to use the correct libraries and paths.
To compile enter

sudo python3 setup.py install

If you don't want to sudo you may want to use the option

--install-lib=destination/directory/

Using BEMEWS

The python code BEMEWS.py uses the module to compute the Earth matter effects upon a neutrino signal from Betelgeuse in SuperK. It will generate a lot of files in out folder named in the script. The output can be switched off by changing the outputflag parameter to False.
A script is provided that allows SNEWPY to include the Earth-matter Effect in its flavor transformation prescription.

Troubleshooting

When using BEMEWS you may have to set the PYTHONPATH environment variable to your PWD and/or wherever the BEMEWS module was installed in steps 3) or step 4)
If your script still cannot find the module you may need to put the *.so library in the same directory as the file. The *.so library is in one of the subfolders in the build directory.
BEMEWS uses OpenMP. You may want to set the OMP_NUM_THREADS environment variable to a number suitable for your machine.
During compilation, you may need to set the LIBOMP_INCLUDE variable to enable the build. If you are a homebrew user on Mac OS X, you can do this with the command

export LIBOMP_INCLUDE=`brew --prefix libomp`/include

bemews's People

Contributors

Stargazers

Watchers

bemews's Issues

clean up non-standard C++ elements in calculations

It looks like there are some non-standard C++ calls in the code that will cause problems for some compilers. Two examples identified by @sanyaarora:

The code assumes M_PI is defined in the math header but this is a non-standard math extension.
In src/BEMEWS/_ext/mstl/math2/analysis/runge kutta.cpp the compiler on her machine is choking on the line static const double b0[]={}; with the error that she cannot allocate an empty array. I also noticed that this allocation seems to implicitly assume the static arrays b0, ..., b5 allocate a contiguous block in memory, which may or may not be respected by all compilers.

There may be other issues that crop up. We'll need people to try installing on windows and linux to get this fully tested and fixed.

add PREM files to sdist/wheel

Right now, the PREM files (PREM.rho.dat and PREM.Ye.dat) are hard-coded in EMEWS_example.py; so the user has to download them and ensure they are in the current working directory.
Going forward, we should add them to the installable package (i.e. sdist or wheel), so users automatically get them when they run pip install. We would then be able to access the files via importlib.resources, similar to the SNOwGLoBES data files.

SNEWPY Integration Example

The README for this repository states "A script is provided that allows SNEWPY to include the Earth-matter Effect in its flavor transformation prescription." If possible, could the name and location of this script be added to the readme? I am having trouble finding it.

Add workflow to publish releases to PyPI

In addition to building BEMEWS in GitHub Actions, we should add a workflow to automatically publish releases to PyPI.
The recommended way to do this is by creating a “Trusted Publisher” on PyPI; see the SNOwGLoBES publish workflow for an example.

Update the BEMEWS driver to be a bit more flexible about user input.

Build on Linux and Windows as part of GitHub Actions

In #2, I’ve focussed on getting this to build on macOS; and the workflow is currently skipping Linux and Windows (which I can’t test on my machine).
Ideally, this would only require modifying a single install step per OS, to

install any OS-specific dependencies
export the LIBOMP_INCLUDE environment variable

… and everything else should remain unchanged.
(In practice, I suspect it won’t go quite as smoothly; but we should be able to figure this out.)

@jpkneller and @Sheshuk, I think you said you’d managed to compile EMEWS on those systems? Could you help with this?