Skip to content

Latest commit

 

History

History
97 lines (60 loc) · 2.44 KB

README.md

File metadata and controls

97 lines (60 loc) · 2.44 KB

FITSInn

Place where your FITS files feel good.

Purpose

FITSInn is an easy-to-use tool for storing and analyzing technical metadata extracted by characterisation tools like FITS.

FITSInn Screenshot

Key Features:

  • Intuitive User Interface: Enhanced user experience through a sleek and streamlined interface.
  • File Characterisation: Analyze uploaded files using FITS without storing the original files.
  • Data Analysis Tools:
    • Advanced filtering,
    • Drill-down capabilities,
    • Property value aggregations,
    • Distribution visualizations,
    • Sampling options.
  • Conflict Management: Resolve metadata conflicts effortlessly.
  • Automation Support: Comes with a REST API to integrate into your workflows.

Installation

Deployment (Production)

To deploy FITSInn, use the Docker images provided and execute the following docker-compose command:

docker-compose -f docker-compose.yaml up --pull

Note:

  • Deployment to Docker Swarm or Kubernetes (K8S) is possible but not covered in this guide.

Upgrade (Production)

To upgrade FITSInn, use the Docker images provided:

docker-compose -f docker-compose.yaml down
docker-compose -f docker-compose.yaml up --pull

Note:

  • The first command will remove all previously created containers. This will cause deletion of all ingested collections.

Local Development Build

To build the Docker images from scratch and start FITSInn locally:

docker-compose -f docker-compose.dev.yaml up --build

Uploading Files to FITSInn

Using Bash:

bash ./utils/fileupload.sh http://localhost:8082 ~/path/to/files collection_name

Using Python:

Ensure you have the requests library installed. Then run:

python ./utils/fileupload.py http://localhost:8082/multipleupload ~/path/to/files 100 3 collection_name
  • URL: http://localhost:8082 is suitable for local deployments.
  • Path to Files: Replace ~/path/to/files with the actual directory path containing the files.
  • Collection Name: Replace collection_name with a name for your collection.

Reporting Issues

If you encounter any issues while using FITSInn, please report them on GitHub:

Submit an Issue

License

FITSInn is released under the MIT license. For more details, see the LICENSE file.