xispa / senaite.core

Open Source Web-based Laboratory Information Management System

— SENAITE.CORE: the heart of SENAITE.LIMS, the evolution of Bika LIMS

Introduction

SENAITE.CORE is an Open Source Laboratory Information Management System (LIMS) for enterprise environments, especially focused to behave with high speed, excellent performance and good stability.

This software is a derivative work of BikaLIMS software and comes with the same user interface. Since SENAITE.CORE provides the core functionalities and entities used by SENAITE.LIMS, the installation of the latter is strongly recommended for an optimal user experience.

Installation

SENAITE.CORE is built on top of Plone CMS, so it must be installed first. Please, follow the installation instructions for Plone 4.x first.

Once Plone 4.x is installed successfully, you can choose any of the two options below:

Ready-to-go installation

With this installation modality, the sources from senaite.core will be downloaded automatically from Python Package Index (Pypi). If you want the latest code from the source code repository, follow the installation instructions for development.

Create a new buildout file senaite.cfg which extends your existing buildout.cfg – this way you can easily keep development stuff separate from your main buildout.cfg which you can also use on the production server:

[buildout]
index = https://pypi.python.org/simple
extends = buildout.cfg

[instance]
eggs +=
    senaite.core

Note that with this approach you do not need to modify the existing buildout.cfg file.

Then build it out with this special config file:

bin/buildout -c senaite.cfg

and buildout will automatically download and install all required dependencies.

For further details about Buildout and how to install add-ons for Plone, please check Installing add-on packages using Buildout from Plone documentation.

Installation for development

This is the recommended approach how to enable senaite.core for your development environment. With this approach, you'll be able to download the latest source code from senaite.core's repository and contribute as well.

Use git to fetch senaite.core source code to your buildout environment:

cd src
git clone git://github.com/senaite/senaite.core.git senaite.core

Create a new buildout file senaite.cfg which extends your existing buildout.cfg – this way you can easily keep development stuff separate from your main buildout.cfg which you can also use on the production server.

senaite.cfg:

[buildout]
index = https://pypi.python.org/simple
extends = buildout.cfg
develop +=
    src/senaite.core

[instance]
eggs +=
    senaite.core

Note that with this approach you do not need to modify the existing buildout.cfg file.

Then build it out with this special config file:

bin/buildout -c senaite.cfg

and buildout will automatically download and install all required dependencies.

Contribute

We want contributing to SENAITE.CORE to be fun, enjoyable, and educational for anyone, and everyone. This project adheres to the Contributor Covenant. By participating, you are expected to uphold this code. Please report unacceptable behavior.

Contributions go far beyond pull requests and commits. Although we love giving you the opportunity to put your stamp on SENAITE.CORE, we also are thrilled to receive a variety of other contributions. Please, read Contributing to senaite.core document.

Feedback and support

• Gitter channel
• Users list

License

SENAITE.CORE Copyright (C) 2018 Senaite Foundation

This software, henceforth "SENAITE.CORE", an add-on for Plone software, is a derivative work of BIKALIMS.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

This program 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.

SENAITE.CORE uses third party libraries that are distributed under their own terms (see LICENSE-3RD-PARTY.rst)