This is the official repository for mMass on Python3.
For more information please see the official mMass homepage at www.mmass.org. Many thanks to Martin Strohalm for his hard work on the project over many years!
We have a package available on pip. To install:
pip install --user mmass
Then invoke at the command line with:
mmass
or, if you haven't configured your $PATH to contain the install location of pip programs:
python3 -m mmass
A Windows installer is provided with each release, and can be obtained by visiting the releases page.
To install, download and run mMass_windows_installer.exe.
A Mac app file is provided with each release, and can also be obtained by visiting the releases page.
To install, download mMass_mac_installer.zip. Extract the file, right click, and select open.
Currently the installer is unsigned, so you might get a warning about the developer being unauthorised. If this concerns you, you can verify our build by building from source.
For technical reasons, mMass currently does not run on the M1 architecture. For more information, see section Building from source.
Many thanks to the FINDER project for sponsoring the recent overhaul work, through whom the software has been made runnable on Python3 and WxWidgets Phoenix.
Thanks also to Warriner Lab for providing support and testing, and funding the updated MacOS installer.
mMass uses poetry as the build system. To get started ensure poetry is installed, then clone the mMass repository.
Due to this well-known issue, the wxPython toolkit must be compiled from scratch. Poetry will handle this, but you require the build dependencies.
Ensure all the dependencies for building wxPython are installed on your system. For Fedora GNU/Linux (32), this is currently:
python3
python3-devel
gtk3-devel
gstreamer1-devel
freeglut-devel
libjpeg-turbo-devel
libpng-devel
libtiff-devel
SDL-devel
libnotify-devel
libSM-devel
For Debian, this is currently:
python3
python3-dev
freeglut3-dev
libwebkitgtk-3.0-dev
libjpeg-dev
libpng-dev
libtiff-dev
libsdl-dev
libnotify-dev
libsm-dev
From within the repository, install the dependencies into the venv with:
poetry install
Don't be surprised if installing wxPython takes a long time: the entire UI toolkit is being compiled from source.
Run the software:
poetry run mmass
Build software packages with:
poetry build
Your packages will be built within the dist/ directory.
Microsoft Windows does not come with a C compiler built in. Since mMass uses a Python extension module, written in C, to speed up certain calculations, we must first install Microsoft Visual C++ 14.0 (or newer).
Go to the Visual Studio downloads page, and download Visual Studio 2019 (or newer) Community edition. Run the installer.
You will be presented with a list of packages to install. Under the Workloads tab, select Desktop development with C++, and in the sidebar ensure that the MSVC option is selected.
You might also want to use this installed to install Python onto your machine, if you haven't already done so.
Ensure you have installed the poetry build system, clone the mMass repository.
From within the repository, install the dependencies into the venv with:
poetry install
Run the software:
poetry run mmass
Build software packages with:
poetry build
Your packages will be built within the dist/ directory.
NB: mMass is currently known to not build correctly on M1 silicon, because of this upstream issue. Once Python3.9 is supported on MacOS by default, it will become possible to build a new package supporting M1.
mMass uses poetry as the build system. To get started ensure poetry is installed, then clone the mMass repository.
You may need to add the poetry install location to your shell's $PATH depending on the install method.
From within the repository, install the dependencies into the venv with:
poetry install
Run the software:
poetry run mmass
Build software packages with:
poetry build
Your packages will be built within the dist/ directory.
Before proceeding with packaging steps, first ensure that you've built mMass from source on your current machine.
We currently only compile mMass for x86_64. This must be done using manylinux to maintain ABI compatibility between versions.
Firstly, get a fresh build environment container. We're using podman:
podman pull quay.io/pypa/manylinux_2_24_x86_64
podman run -i quay.io/pypa/manylinux_2_24_x86_64
podman ps # To get CONTAINER ID
podman exec -it [CONTAINER ID] /bin/bash
And then within the container:
cd /root
git clone https://github.com/dreamingspires/mMass
cd mMass
Now install and build the repository:
apt update
apt install -y python3-pip libgtk-3-dev gstreamer1.0 gstreamer1.0-plugins-base freeglut3-dev libwebkitgtk-3.0-dev libjpeg-dev libpng-dev libtiff-dev libsdl-dev libnotify-dev libsm-dev libwebkitgtk-dev
python3 -m pip install --user poetry
python3 -m poetry env use /opt/python/cp37-cp37m/bin/python3
python3 -m poetry install # This will probably take a while
poetry build
To prepare a release for pypi, see this guide. In summary:
poetry install
poetry build
python3 -m twine upload --repository testpypi dist/*
python3 -m twine upload --repository pypi dist/*
Ensure that makensis is installed:
choco install nsis.portable
Build the executable in dist/. From the root directory of the repo:
poetry install
poetry run pyinstaller .\installer\windows.spec
Build the installer in dist/. From the root directory of the repo:
makensis.exe /DPRODUCT_VERSION=0.1.0 installer\windows_installer.nsi
From within the installed project directory:
poetry run python3 installer/mac_setup.py py2app
The resulting application will be built inside ./dist/mMass.
Finally, package the application into a .zip archive for easier distribution. You can do this by launching Finder, right-clicking on the application, and selecting Compress "mMass".
Issues can be file in the GitHub bug tracker. PRs welcomed!
- Update version in
pyproject.tomlandgui/config.py - (Future) run unit tests
- Build installers (see below)
- Test installers
- Commit, tag, push
- Publish to PyPi with poetry publish
- Create a release on Github, including the changelog, source, and installers
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
For Research Use Only. Not for use in diagnostic procedures.
This program and its documentation are Copyright 2005-2013 by Martin Strohalm, 2020-2021 by Dreaming Spires.
This program, along with all associated documentation, is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation. See the LICENSE.TXT file for details (and make sure that you have entirely read and understood it!)
Please note in particular that, if you use this program, or ANY part of it - even a single line of code - in another application, the resulting application becomes also GPL. In other words, GPL is a "contaminating" license.
If you do not understand any portion of this notice, please seek appropriate professional legal advice. If you do not or - for any reason - you can not accept ALL of these conditions, then you must not use nor distribute this program.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License (file LICENSE.TXT) for more details.
The origin of this software must not be misrepresented; you must not claim that you wrote the original software. Altered source versions must be clearly marked as such, and must not be misrepresented as being the original software.
This notice must not be removed or altered from any source distribution.