mirror of https://github.com/mamba-org/mamba.git
197 lines
8.9 KiB
Markdown
197 lines
8.9 KiB
Markdown
# Mamba: The Fast Cross-Platform Package Manager
|
|
|
|
|
|
|
|
<!-- markdownlint-disable-file MD033 -->
|
|
|
|
<table>
|
|
<thead align="center" cellspacing="10">
|
|
<tr>
|
|
<th colspan="3" align="center" border="">part of mamba-org</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr background="#FFF">
|
|
<td align="center">Package Manager <a href="https://github.com/mamba-org/mamba">mamba</a></td>
|
|
<td align="center">Package Server <a href="https://github.com/mamba-org/quetz">quetz</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
## mamba
|
|
|
|
[](https://github.com/mamba-org/mamba/actions/workflows/tests.yml?query=branch%3Amain)
|
|
[](https://gitter.im/mamba-org/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
[](https://mamba.readthedocs.io/en/latest)
|
|
[](https://gurubase.io/g/mamba)
|
|
|
|
`mamba` is a reimplementation of the conda package manager in C++.
|
|
|
|
- parallel downloading of repository data and package files using multi-threading
|
|
- libsolv for much faster dependency solving, a state of the art library used in the RPM package manager of Red Hat, Fedora and OpenSUSE
|
|
- core parts of `mamba` are implemented in C++ for maximum efficiency
|
|
|
|
At the same time, `mamba` utilizes the same command line parser, package installation and deinstallation code and transaction verification routines as `conda` to stay as compatible as possible.
|
|
|
|
`mamba` is part of the [conda-forge](https://conda-forge.org/) ecosystem, which also consists of `quetz`, an open source `conda` package server.
|
|
|
|
You can read our [announcement blog post](https://medium.com/@QuantStack/open-software-packaging-for-science-61cecee7fc23).
|
|
|
|
## micromamba
|
|
|
|
`micromamba` is the statically linked version of `mamba`.
|
|
|
|
It can be installed as a standalone executable without any dependencies, making it a perfect fit for CI/CD pipelines and containerized environments.
|
|
|
|
See the [documentation on `micromamba`](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html) for details.
|
|
|
|
## `mamba` v.s. `micromamba`
|
|
|
|
`mamba` has to be preferred when:
|
|
|
|
- `libmambapy` or `libmamba` is used by other software in the same environment.
|
|
- Scenarios where regular updates to libraries are required (especially for security).
|
|
- Environments are focused on reducing disk space usage for dependencies.
|
|
|
|
`micromamba` has to be preferred when:
|
|
|
|
- Relying a single self-contained executable is required.
|
|
- A miniforge distribution is not present.
|
|
- Usage requires minimal runtime.
|
|
|
|
## Installation
|
|
|
|
Please refer to the [mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html)
|
|
and [micromamba](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html) installation guide in the documentation.
|
|
|
|
## Additional features in Mamba and Micromamba
|
|
|
|
`mamba` and `micromamba` come with features on top of stock `conda`.
|
|
|
|
### `repoquery`
|
|
|
|
To efficiently query repositories and query package dependencies you can use `mamba repoquery` or `micromamba repoquery`.
|
|
|
|
See the [repoquery documentation](https://mamba.readthedocs.io/en/latest/user_guide/mamba.html#repoquery) for details.
|
|
|
|
### Installing lock files
|
|
|
|
`micromamba` can be used to install lock files generated by [conda-lock](https://conda.github.io/conda-lock/) without having to install `conda-lock`.
|
|
|
|
Simply invoke `micromamba create` with the `-f` option, providing an environment lockfile whose name ends with
|
|
`-lock.yml` or `-lock.yaml`; for instance:
|
|
|
|
```bash
|
|
micromamba create -n my-env -f conda-lock.yml
|
|
```
|
|
|
|
### setup-micromamba (setup-miniconda replacement)
|
|
|
|
[setup-micromamba](https://github.com/marketplace/actions/setup-micromamba) is a replacement for [setup-miniconda](https://github.com/marketplace/actions/setup-miniconda) that uses `micromamba`.
|
|
|
|
It can significantly reduce your CI setup time by:
|
|
|
|
- Using `micromamba`, which takes around 1 s to install.
|
|
- Caching package downloads.
|
|
- Caching entire `conda` environments.
|
|
|
|
## Differences with `conda`
|
|
|
|
While `mamba` and `micromamba` are generally a drop-in replacement for `conda` there are some differences:
|
|
|
|
- `mamba` and `micromamba` normalize `MatchSpec` strings to the simplest form, whereas `conda` use a more verbose form
|
|
This can lead to slight differences in the output of `conda env export` and `mamba env export`.
|
|
|
|
## Development installation
|
|
|
|
Please refer to the instructions given by the [official documentation](https://mamba.readthedocs.io/en/latest/developer_zone/dev_environment.html).
|
|
|
|
## API and ABI stability
|
|
|
|
The Mamba project uses [semantic versioning](https://semver.org/) of the form `MAJOR.MINOR.PATCH`.
|
|
While we try to keep things stable for users, we also need to make breaking changes to improve
|
|
Mamba and reduce technical debt.
|
|
Future versions of Mamba may give stronger guarantees.
|
|
|
|
### `libmamba` (C++)
|
|
|
|
We are not aware of consumers of the C++ API, so we give ourselves room for improvements.
|
|
For `libmamba`, the term _backward compatible_ is understood as follows:
|
|
|
|
- _ABI backward compatible_ means that you can replace the library binary files without recompiling
|
|
your code with the updated headers.
|
|
The observed behavior will be the same, except for bugs (disappearing, hopefully) and performance.
|
|
- _API backward compatible_ means that you must recompile your code with the new library
|
|
version code, but you won't need to change your code, just re-build it.
|
|
This applies as long as you did not use any declaration understood to be private, for instance
|
|
in the `detail` sub-namespaces.
|
|
The observed behavior will be the same, except for bugs (disappearing, hopefully) and performance.
|
|
When declarations are deprecated but not removed and still functional, we consider it also
|
|
backward compatible, as only the observed behavior during compilation changes.
|
|
|
|
With this in mind, `libmamba` offers the following guarantees:
|
|
|
|
- `PATCH` releases are API and ABI backward compatible;
|
|
- `MINOR` releases are API compatible for declarations in `mamba/api`,
|
|
They can break API elsewhere and ABI anywhere;
|
|
- `MAJOR` releases make no guarantees.
|
|
|
|
### `libmambapy` (Python)
|
|
|
|
For `libmambapy`, the term _API backward compatible_ implies that your Python code will work the
|
|
same for a newer version of `libmambapy` as long as you did not use any declaration understood to
|
|
be private, for instance accessed with a name starting with an `_`.
|
|
The observed behavior will be the same, except for bugs (disappearing, hopefully) and performance.
|
|
When declarations are deprecated but not removed and still functional, we consider it also
|
|
backward compatible, as the behavior is only observable when activating Python
|
|
`DeprecationWarning`, which is usually only activated in development.
|
|
|
|
With this in mind, `libmambapy` offers the following guarantees:
|
|
|
|
- `PATCH` releases are API backward compatible;
|
|
- `MINOR` releases are API backward compatible;
|
|
- `MAJOR` releases make no guarantees.
|
|
|
|
### `mamba` and `micromamba` (executables)
|
|
|
|
For executables, the term _backward compatible_ applies to programmable inputs and outputs and means
|
|
that your code (including shell scripts) will work with newer versions of the executable without
|
|
modifications.
|
|
Programmable inputs/outputs include executable name, command line arguments, configuration files,
|
|
environment variables, JSON command line outputs, and files created.
|
|
It _excludes_ human-readable output and error messages, and thus deprecation warnings written
|
|
in the human-readable output.
|
|
|
|
With this in mind, `mamba` and `micromamba` offer the following guarantees:
|
|
|
|
- `PATCH` releases are backward compatible;
|
|
- `MINOR` releases are backward compatible;
|
|
- `MAJOR` releases make no guarantees.
|
|
|
|
## Support us
|
|
|
|
Only `mamba` and `micromamba` 2.0 and later are supported and are actively developed.
|
|
|
|
The `1.x` branch is only maintained for addressing security issues such as CVEs.
|
|
|
|
For questions, you can also join us on the [QuantStack Chat](https://gitter.im/QuantStack/Lobby)
|
|
or on the [Conda channel](https://gitter.im/conda/conda) (note that this project is not officially affiliated with `conda` or Anaconda Inc.).
|
|
|
|
## License
|
|
|
|
We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.
|
|
|
|
This software is licensed under the BSD-3-Clause license. See the [LICENSE](LICENSE) file for details.
|
|
|
|
---
|
|
|
|
### Biweekly Dev Meeting
|
|
|
|
We have videoconference meetings every two weeks where we discuss what we have been working on and get feedback from one another.
|
|
|
|
Anyone is welcome to attend, if they would like to discuss a topic or just listen in.
|
|
|
|
- When: Tuesday [4:00 PM CET (Europe)](https://calendar.google.com/calendar/u/0/embed?src=ab3jrfpede0kq0ubsroe82cd00@group.calendar.google.com&ctz=Europe/Paris)
|
|
- Where: [Mamba jitsi](https://meet.jit.si/mamba-org)
|
|
- What: [Meeting notes](https://hackmd.io/@guj2k_aBSSyr1YHBG9raWw/HyHt-Ekzj)
|