[](https://www.gnu.org/licenses/lgpl-3.0)
[](https://github.com/mxcube/mxcubecore/actions/workflows/tests.yml)
# Backend of MXCuBE
`mxcubecore` is the back-end library for
[MXCuBE Qt](https://github.com/mxcube/mxcubeqt/)
and [MXCuBE Web](https://github.com/mxcube/mxcubeweb/).
It allows access to the beamline control system and instrumentation.
It acts as a container of single Python objects (called "hardware objects").
Please read the
[contributing guidelines](https://mxcubecore.readthedocs.io/en/stable/dev/contributing.html)
before submitting your code to the repository.
## License
MXCuBE is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
MXCuBE 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 Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with MXCuBE. If not, see <https://www.gnu.org/licenses/>.
## Installation
Installation of the `mxcubecore` module is commonly done as a dependency of either
[MXCuBE Web](https://github.com/mxcube/mxcubeweb/)
or [MXCuBE Qt](https://github.com/mxcube/mxcubeqt/).
Standalone installation of the `mxcubecore` for development purposes can be done
via Poetry with `poetry install`
or via pip with `python -m pip install --editable .` (don't forget the trailing dot `.`).
`mxcubecore` depends on `python-ldap` that in turn depends on the `openldap` system library.
It can be installed in a conda environment: `conda install openldap`
or on systems using the apt package manager (Debian and derivatives, including Ubuntu):
`sudo apt-get install -y libldap2-dev libsasl2-dev`.
See [python-ldap](https://www.python-ldap.org/en/python-ldap-3.4.3/installing.html#debian)
for more information.
See [Developer documentation](https://mxcubecore.readthedocs.io/)
for more information on working with mxcubecore.
Raw data
{
"_id": null,
"home_page": "http://github.com/mxcube/mxcubecore",
"name": "mxcubecore",
"maintainer": "Marcus Oscarsson",
"docs_url": null,
"requires_python": "<3.12,>=3.8",
"maintainer_email": "mxcube@esrf.fr",
"keywords": "mxcube, mxcube3, mxcubecore",
"author": "The MXCuBE collaboration",
"author_email": "mxcube@esrf.fr",
"download_url": "https://files.pythonhosted.org/packages/e3/7f/abee045434a50a54f56d9e232c9a2571a397739cc56a45f28190ac0679f8/mxcubecore-1.207.0.tar.gz",
"platform": null,
"description": "[](https://www.gnu.org/licenses/lgpl-3.0)\n[](https://github.com/mxcube/mxcubecore/actions/workflows/tests.yml)\n\n\n\n# Backend of MXCuBE\n\n`mxcubecore` is the back-end library for\n[MXCuBE Qt](https://github.com/mxcube/mxcubeqt/)\nand [MXCuBE Web](https://github.com/mxcube/mxcubeweb/).\nIt allows access to the beamline control system and instrumentation.\nIt acts as a container of single Python objects (called \"hardware objects\").\n\nPlease read the\n[contributing guidelines](https://mxcubecore.readthedocs.io/en/stable/dev/contributing.html)\nbefore submitting your code to the repository.\n\n## License\n\nMXCuBE is free software: you can redistribute it and/or modify\nit under the terms of the GNU Lesser General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nMXCuBE is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Lesser General Public License for more details.\n\nYou should have received a copy of the GNU Lesser General Public License\nalong with MXCuBE. If not, see <https://www.gnu.org/licenses/>.\n\n\n## Installation\n\nInstallation of the `mxcubecore` module is commonly done as a dependency of either\n[MXCuBE Web](https://github.com/mxcube/mxcubeweb/)\nor [MXCuBE Qt](https://github.com/mxcube/mxcubeqt/).\n\nStandalone installation of the `mxcubecore` for development purposes can be done\nvia Poetry with `poetry install`\nor via pip with `python -m pip install --editable .` (don't forget the trailing dot `.`).\n\n`mxcubecore` depends on `python-ldap` that in turn depends on the `openldap` system library.\nIt can be installed in a conda environment: `conda install openldap`\nor on systems using the apt package manager (Debian and derivatives, including Ubuntu):\n`sudo apt-get install -y libldap2-dev libsasl2-dev`.\nSee [python-ldap](https://www.python-ldap.org/en/python-ldap-3.4.3/installing.html#debian)\nfor more information.\n\nSee [Developer documentation](https://mxcubecore.readthedocs.io/)\nfor more information on working with mxcubecore.\n",
"bugtrack_url": null,
"license": "LGPL-3.0-or-later",
"summary": "Core libraries for the MXCuBE application",
"version": "1.207.0",
"project_urls": {
"Documentation": "https://mxcubecore.readthedocs.io/",
"Homepage": "http://github.com/mxcube/mxcubecore",
"Repository": "http://github.com/mxcube/mxcubecore"
},
"split_keywords": [
"mxcube",
" mxcube3",
" mxcubecore"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6f043c1cd44abac57139895a36609e328f2d656f4c602c9ce4e01515ec418517",
"md5": "6a2bb6531d85e903a35526892753ea50",
"sha256": "40cf3f758e26e2b072908bc44675370b181279e6a2785176af5314fa681448a5"
},
"downloads": -1,
"filename": "mxcubecore-1.207.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6a2bb6531d85e903a35526892753ea50",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.8",
"size": 1377400,
"upload_time": "2025-01-24T13:23:15",
"upload_time_iso_8601": "2025-01-24T13:23:15.632357Z",
"url": "https://files.pythonhosted.org/packages/6f/04/3c1cd44abac57139895a36609e328f2d656f4c602c9ce4e01515ec418517/mxcubecore-1.207.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e37fabee045434a50a54f56d9e232c9a2571a397739cc56a45f28190ac0679f8",
"md5": "b8ac7358116cb60bf018d123f0412337",
"sha256": "10dee8ff539251109640549f5e075edf0cd5c21d6d31e8449611386f3aa02a0b"
},
"downloads": -1,
"filename": "mxcubecore-1.207.0.tar.gz",
"has_sig": false,
"md5_digest": "b8ac7358116cb60bf018d123f0412337",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.8",
"size": 1059605,
"upload_time": "2025-01-24T13:23:18",
"upload_time_iso_8601": "2025-01-24T13:23:18.050721Z",
"url": "https://files.pythonhosted.org/packages/e3/7f/abee045434a50a54f56d9e232c9a2571a397739cc56a45f28190ac0679f8/mxcubecore-1.207.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-24 13:23:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mxcube",
"github_project": "mxcubecore",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "mxcubecore"
}
JSON
