# Panoptic 👀
[](https://pypi.org/project/panoptic)
[](https://pypi.org/project/panoptic)
This documentation also exist in [French](https://github.com/CERES-Sorbonne/Panoptic/blob/main/README-FR.md)
Panoptic is a tool for exploring and annotating large image corpora, using image analysis and machine learning tools to facilitate these tasks.
Since it requires deep learning libraries, it is recommended to use it with a computer with minimal computing capabilities.
> Caution: Panoptic is still in active development and is currently a prototype, it is likely that you will encounter bugs, so we recommend to use this tool only for testing and not to rely on it for a substantial academic work.
## Windows and Linux installation
Python 3.9 or higher is required, and a custom environnment (venv, pyenv, conda etc.) is recommended.
Open a terminal and type:
- `pip install panoptic`
- `panoptic`
## Mac installation
Just like the windows installation but you will need to also install the xcode tools first.
For this, just use this command in a terminal: `xcode-select –-install`, it should trigger the installation of the command line tools.
Then run:
- `pip install panoptic`
- `panoptic`
## Docker installation
If you're having issues with the installation (sometimes the packages can be tricky) or if you just prefair to use Docker it's possible:
Start by installing docker:
- [On MacOS](https://docs.docker.com/desktop/install/mac-install/)
- [On Windows](https://docs.docker.com/desktop/install/windows-install/)
- [On Linux](https://docs.docker.com/desktop/install/linux-install/)
### Option 1 : One folder to rule them all
Make a folder for the docker with a subfolder for the images `/path/to/your/folder/images`.
```console
docker run -it -p 8000:8000 -v /path/to/your/folder:/data --name panoptic ceressorbonne/panoptic
```
### Option 2 : Separate data and images folders
Make a folder for the panoptic datas (database, thumbnails, etc.) `/path/to/your/data/`.
And another one withe your images (could be an existing one) `/path/to/your/images/`.
```console
docker run -it -p 8000:8000 \
-v /path/to/your/data:/data \
-v /path/to/your/images:/data/images \
--name panoptic \
ceressorbonne/panoptic
```
### Access
You can now access panoptic through:
https://localhost:8000
As if you were to launch it with the python version
### Restart
If you happen to stop panoptic, you can re launch it with :
```console
docker start -ia panoptic
```
## Installation (development)
The following steps involve cloning the directory and are recommended for users who wish to have access to the development versions, or who wish to modify the code themselves in order to contribute.
### Backend development only
To test and modify the backend operation, we provide an already built frontend in the backend html folder.
* go to the `panoptic-back` folder
* to install the dependencies
- `python setup.py install` to simply use panoptic
- `pip install -e .` to develop
- `pip install -r requirements.txt` and you have to add `panoptic-back` to the PYTHON_PATH for developping purpose too
* run `python panoptic/main.py`
### Front and back development
1. First of all, perform the installation steps of the backend
2. go to the `panoptic-front` folder
3. Run `npm install`.
4. run `npm run dev`.
5. before running the backend the `PANOPTIC_ENV` environment variable should be set to `DEV` in order to use the development frontend.
Raw data
{
"_id": null,
"home_page": null,
"name": "panoptic",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Data visualization, Image analysis, Image clustering, Image corpora, Machine learning, Web application",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/12/e4/60f47ea17ea2256984b32aa5dab6c34efb4a153c61a55be3a02c4a25f4e8/panoptic-0.3.3.tar.gz",
"platform": null,
"description": "# Panoptic \ud83d\udc40\n\n[](https://pypi.org/project/panoptic)\n[](https://pypi.org/project/panoptic)\n\nThis documentation also exist in [French](https://github.com/CERES-Sorbonne/Panoptic/blob/main/README-FR.md)\n\n\n\nPanoptic is a tool for exploring and annotating large image corpora, using image analysis and machine learning tools to facilitate these tasks. \n\nSince it requires deep learning libraries, it is recommended to use it with a computer with minimal computing capabilities.\n\n> Caution: Panoptic is still in active development and is currently a prototype, it is likely that you will encounter bugs, so we recommend to use this tool only for testing and not to rely on it for a substantial academic work. \n\n## Windows and Linux installation\n\nPython 3.9 or higher is required, and a custom environnment (venv, pyenv, conda etc.) is recommended.\nOpen a terminal and type:\n\n- `pip install panoptic`\n- `panoptic`\n\n## Mac installation\n\nJust like the windows installation but you will need to also install the xcode tools first. \nFor this, just use this command in a terminal: `xcode-select \u2013-install`, it should trigger the installation of the command line tools.\nThen run:\n- `pip install panoptic`\n- `panoptic`\n\n## Docker installation\nIf you're having issues with the installation (sometimes the packages can be tricky) or if you just prefair to use Docker it's possible:\nStart by installing docker:\n- [On MacOS](https://docs.docker.com/desktop/install/mac-install/)\n- [On Windows](https://docs.docker.com/desktop/install/windows-install/)\n- [On Linux](https://docs.docker.com/desktop/install/linux-install/)\n\n### Option 1 : One folder to rule them all\nMake a folder for the docker with a subfolder for the images `/path/to/your/folder/images`.\n```console\ndocker run -it -p 8000:8000 -v /path/to/your/folder:/data --name panoptic ceressorbonne/panoptic\n```\n### Option 2 : Separate data and images folders\nMake a folder for the panoptic datas (database, thumbnails, etc.) `/path/to/your/data/`.\nAnd another one withe your images (could be an existing one) `/path/to/your/images/`.\n```console\ndocker run -it -p 8000:8000 \\\n-v /path/to/your/data:/data \\\n-v /path/to/your/images:/data/images \\\n--name panoptic \\\nceressorbonne/panoptic\n```\n\n### Access\nYou can now access panoptic through:\nhttps://localhost:8000\nAs if you were to launch it with the python version\n\n### Restart\nIf you happen to stop panoptic, you can re launch it with :\n```console\ndocker start -ia panoptic\n```\n\n\n## Installation (development)\nThe following steps involve cloning the directory and are recommended for users who wish to have access to the development versions, or who wish to modify the code themselves in order to contribute.\n\n### Backend development only\n\nTo test and modify the backend operation, we provide an already built frontend in the backend html folder.\n* go to the `panoptic-back` folder\n* to install the dependencies\n - `python setup.py install` to simply use panoptic\n - `pip install -e .` to develop\n - `pip install -r requirements.txt` and you have to add `panoptic-back` to the PYTHON_PATH for developping purpose too\n* run `python panoptic/main.py`\n\n\n### Front and back development\n\n1. First of all, perform the installation steps of the backend\n2. go to the `panoptic-front` folder\n3. Run `npm install`.\n4. run `npm run dev`.\n5. before running the backend the `PANOPTIC_ENV` environment variable should be set to `DEV` in order to use the development frontend.\n",
"bugtrack_url": null,
"license": null,
"summary": "Explore and analyze large datasets of images",
"version": "0.3.3",
"project_urls": {
"Documentation": "https://github.com/CERES-Sorbonne/panoptic#readme",
"Issues": "https://github.com/CERES-Sorbonne/panoptic/issues",
"Lab's website": "https://ceres.sorbonne-universite.fr/",
"Repository": "https://github.com/CERES-Sorbonne/panoptic"
},
"split_keywords": [
"data visualization",
" image analysis",
" image clustering",
" image corpora",
" machine learning",
" web application"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "97c02b0730f46728b5a72adb047aaca0e85824bbb513ae8d2f5ddfd338851be6",
"md5": "692f8fb85cc0a871bfdd7fa0d502cd44",
"sha256": "b2fbcd2d477a96ca9836698840fbecdb27745148c2e198929f934747ddd0bfa6"
},
"downloads": -1,
"filename": "panoptic-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "692f8fb85cc0a871bfdd7fa0d502cd44",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 1016770,
"upload_time": "2024-04-11T13:44:35",
"upload_time_iso_8601": "2024-04-11T13:44:35.910562Z",
"url": "https://files.pythonhosted.org/packages/97/c0/2b0730f46728b5a72adb047aaca0e85824bbb513ae8d2f5ddfd338851be6/panoptic-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "12e460f47ea17ea2256984b32aa5dab6c34efb4a153c61a55be3a02c4a25f4e8",
"md5": "a1f48be277c237292568661a4f3b1204",
"sha256": "9ad2b41fd311ff6cf78ab6c7af1fdabbdb4e86d8f55319fd94e8d91ba7df4b9f"
},
"downloads": -1,
"filename": "panoptic-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "a1f48be277c237292568661a4f3b1204",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1003537,
"upload_time": "2024-04-11T13:44:40",
"upload_time_iso_8601": "2024-04-11T13:44:40.037040Z",
"url": "https://files.pythonhosted.org/packages/12/e4/60f47ea17ea2256984b32aa5dab6c34efb4a153c61a55be3a02c4a25f4e8/panoptic-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-11 13:44:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CERES-Sorbonne",
"github_project": "panoptic#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "panoptic"
}
JSON
