# miso-lims **Repository Path**: jimhacker/miso-lims ## Basic Information - **Project Name**: miso-lims - **Description**: GitHub复制项目，可以直接去github查看最新版本 - **Primary Language**: Java - **License**: GPL-3.0 - **Default Branch**: master - **Homepage**: https://github.com/miso-lims/miso-lims.git - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1 - **Created**: 2020-02-08 - **Last Updated**: 2020-12-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README [![Build Status](https://travis-ci.org/miso-lims/miso-lims.svg?branch=develop)](https://travis-ci.org/miso-lims/miso-lims) [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=uk.ac.bbsrc.tgac.miso:miso&metric=alert_status)](https://sonarcloud.io/dashboard?id=uk.ac.bbsrc.tgac.miso:miso) [![DOI](https://zenodo.org/badge/4726428.svg)](https://zenodo.org/badge/latestdoi/4726428) [![Gitter](https://badges.gitter.im/miso-lims/community.svg)](https://gitter.im/miso-lims/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Documentation Status](https://readthedocs.org/projects/miso-lims-docs/badge/?version=latest)](https://miso-lims.readthedocs.io/projects/docs/en/latest/?badge=latest) # MISO: An open source LIMS for small-to-large scale sequencing centres © 2019. [Ontario Institute for Cancer Research](http://oicr.on.ca), Toronto, Canada, [Earlham Institute](http://earlham.ac.uk/), Norwich, UK. > MISO project contacts: [Morgan Taschuk](morgan.taschuk@oicr.on.ca), [Robert Davey](robert.davey@earlham.ac.uk) > > MISO 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, either version 3 of the License, or > (at your option) any later version. > > MISO 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 for more details. > > You should have received a copy of the GNU General Public License > along with MISO. If not, see . ## Trying MISO ### Docker The simplest way to get MISO up and running quickly is to use [Docker](https://www.docker.com/) compose. Images of the most recent MISO releases are available on Docker Hub in the [misolims](https://hub.docker.com/r/misolims/) organisation. #### Prerequisites Install required dependencies: 1. [Install Docker 18.06.0+](https://docs.docker.com/install/) 1. If necessary, [install Docker Compose](https://docs.docker.com/compose/install/) Download and extract the `.docker` directory from Github into `miso-lims-compose`. ``` wget https://github.com/miso-lims/miso-lims/archive/master.zip unzip master.zip 'miso-lims-master/.docker/*' mv miso-lims-master/.docker miso-lims-compose rm -r master.zip miso-lims-master/ ``` You are now ready to run MISO. #### Quick Start To bring up a demo environment, install the pre-requisites above and run the following commands. **Plain sample mode** has a straightforward Sample -> Library -> Library Aliquot -> Pool workflow and is sufficient for basic laboratory tracking for sequencing. Launch the plain sample demo with docker-compose: ``` bash cd miso-lims-compose export MISO_DB_USER=tgaclims && export MISO_DB=lims && export MISO_DB_PASSWORD_FILE=./.miso_db_password && export MISO_TAG=latest echo "changeme" > ./.miso_db_password docker-compose -f demo.plain.yml up ``` **Detailed sample mode** has all of the features of plain sample mode, plus it allows users to build a hierarchy of Samples (e.g. Identity -> Tissue -> Slide -> gDNA (stock) -> gDNA (aliquot) and also includes alias autogeneration. Launch the detailed sample demo with docker-compose: ```bash cd miso-lims-compose export MISO_DB_USER=tgaclims && export MISO_DB=lims && export MISO_DB_PASSWORD_FILE=./.miso_db_password && export MISO_TAG=latest echo "changeme" > ./.miso_db_password docker-compose -f demo.detailed.yml up ``` For both environments, navigate to [http://localhost](http://localhost) and use the credentials **admin**/**admin**. Once you are finished with the container, make sure to run `docker-compose -f down`, where `` is either `demo.plain.yml` or `demo.detailed.yml`. This will clean up the instances and networks and release their resources to the host operating system. These compose files are intended as a demonstration and __not a permanent installation__. Please see the [Docker Compose Guide](https://miso-lims.readthedocs.io/projects/docs/en/latest/admin/compose-installation-guide/) for more information on configuring the containers and the compose files. ## User Tutorial There are tutorials available to introduce and train new users to MISO's functionality. * [Plain sample tutorials](https://miso-lims.github.io/walkthroughs/plain-index) * [Detailed sample tutorials](https://miso-lims.github.io/walkthroughs) Some of the resources (MISO URL, ways of contacting the MISO administrators) can be changed by forking and configuring the [tutorial repository](https://github.com/miso-lims/walkthroughs) to suit your lab's specific needs. ## Running an Instance of MISO To run your own MISO instance in the long term, download the [latest release](https://github.com/miso-lims/miso-lims/releases/latest). Installation and configuration details can be found in the [MISO building and deploying guide](https://miso-lims.readthedocs.io/projects/docs/en/latest/admin/installation-guide/). ## Contact and Community - [MISO Twitter](https://twitter.com/misolims) : for news and updates - [MISO Community Gitter](https://gitter.im/miso-lims/community) : for user group and developer questions and discussion - [MISO Users Gitter](https://gitter.im/miso-lims/users) : for user group questions and discussion - [MISO Developers Gitter](https://gitter.im/miso-lims/developers) : for developer questions and discussion