extensions/net.sf.basedb.meludi/trunk/README

Code
Comments
Other
Rev Date Author Line
2951 18 Nov 14 olle 1 ===================================================
3507 24 Sep 15 olle 2 MeLuDI extension package README
2951 18 Nov 14 olle 3 ===================================================
2951 18 Nov 14 olle 4
2933 14 Nov 14 olle 5 == Requirements ==
2933 14 Nov 14 olle 6
5465 04 Jun 19 olle 7  1. BASE 3.15 or later.
2933 14 Nov 14 olle 8  
2933 14 Nov 14 olle 9 == Introduction ==
2933 14 Nov 14 olle 10
2933 14 Nov 14 olle 11 This package is an extension package to BASE that can be used to
2933 14 Nov 14 olle 12 simplify biosource and sample registration.
2933 14 Nov 14 olle 13
2933 14 Nov 14 olle 14  * The homepage for this extension: 
2937 17 Nov 14 olle 15    http://baseplugins.thep.lu.se/wiki/net.sf.basedb.meludi
2933 14 Nov 14 olle 16
2933 14 Nov 14 olle 17 == Installation and updating ==
2933 14 Nov 14 olle 18
2937 17 Nov 14 olle 19  1. Download the meludi-*.tar.gz file.
2933 14 Nov 14 olle 20  2. Unpack the downloaded file to a directory of your choice.
3507 24 Sep 15 olle 21  3. Copy the 'meludi.jar' file to your BASE plug-ins directory,
3507 24 Sep 15 olle 22     i.e. the directory specified by the 'plugins.dir' setting in 'base.config'.
2933 14 Nov 14 olle 23  4. Edit and copy configuration files to their correct location. See
2933 14 Nov 14 olle 24     config/readme.txt for more information. If this is a first-time
2933 14 Nov 14 olle 25     installation shut down BASE and run 'updatedb.sh' script so
2933 14 Nov 14 olle 26     that additional reporter annotations and raw data columns are
2933 14 Nov 14 olle 27     created.
3190 18 Mar 15 olle 28  5. Log in to BASE as a user with Administrator privileges. 
2933 14 Nov 14 olle 29  6. Go to 'Administrate->Plug-ins & Extensions->Overview' page.
2937 17 Nov 14 olle 30     Run the installation wizard and select to install/update 'meludi.jar'.
2933 14 Nov 14 olle 31  7. Create a project and set it as the active project. This step is
2937 17 Nov 14 olle 32     optional but is recommended. Running MeLuDi without an active project
4199 31 Oct 16 olle 33     will generate warning messages later on. MeLuDI 1.2 and later use a
4199 31 Oct 16 olle 34     counter service to display numbers of different item selections on
4199 31 Oct 16 olle 35     the main page.
2937 17 Nov 14 olle 36  8. Go to the Extensions->MeLuDi menu. Select the 'Installation wizard'
3507 24 Sep 15 olle 37     If the 'MeLuDi' menu item is not visible try BASE->Reload permissions menu.
2933 14 Nov 14 olle 38  9. It should display a list with several error message about missing items.
2933 14 Nov 14 olle 39     Click on the "Create missing items" button to create them. If no project
3028 11 Dec 14 olle 40     was created in step 6, all annotation types will be shared with the
2933 14 Nov 14 olle 41     'PatientCurator' group, otherwise only some will be shared to the
4199 31 Oct 16 olle 42     group and some will be shared to the active project. Run the MeLuDI
4199 31 Oct 16 olle 43     installation wizard for each of the configured projects as active project.
2933 14 Nov 14 olle 44 10. Manual fixes. Check the release information if any manual changes are 
2933 14 Nov 14 olle 45     needed to items that already exists in BASE.
2933 14 Nov 14 olle 46 11. Done. 
2933 14 Nov 14 olle 47
2933 14 Nov 14 olle 48 == Using ==
2933 14 Nov 14 olle 49  
3507 24 Sep 15 olle 50 MeLuDI appears as a menu entry in the Extensions menu. All operations
2933 14 Nov 14 olle 51 are available on that page. 
2933 14 Nov 14 olle 52
2933 14 Nov 14 olle 53  * Installation wizard:
2933 14 Nov 14 olle 54    This entry is available if the logged in user is an 'Administrator' and
3507 24 Sep 15 olle 55    will perform some basic checks that items that are needed by MeLuDI
2951 18 Nov 14 olle 56    exists and have been properly configured. Items that doesn't exist can
2933 14 Nov 14 olle 57    be created automatically.
2933 14 Nov 14 olle 58    
2933 14 Nov 14 olle 59  * Personal information registration wizard:
2933 14 Nov 14 olle 60    This entry is available for 'Administrators' and members of the 
2933 14 Nov 14 olle 61    'PatientCurator' group. It is used to register new patients and
2951 18 Nov 14 olle 62    cases. It can also be used to update an existing case with
2951 18 Nov 14 olle 63    patient info.
2933 14 Nov 14 olle 64  
2933 14 Nov 14 olle 65  * Specimen tube registration wizard:
2933 14 Nov 14 olle 66    This entry is available for those with permission to create samples.
2933 14 Nov 14 olle 67    It is used to register new specimen tubes for cases that are not yet
2933 14 Nov 14 olle 68    in BASE.
2933 14 Nov 14 olle 69  
3190 18 Mar 15 olle 70  * DNA/RNA extraction wizards:
3190 18 Mar 15 olle 71    These entries are available for those with permission to create samples.
3190 18 Mar 15 olle 72    They are used to register new extracts from specimens, and update quantity
3190 18 Mar 15 olle 73    values for input RNA/DNA.
3706 19 Jan 16 olle 74
3706 19 Jan 16 olle 75  * Library preparation reagent kit wizards:
3706 19 Jan 16 olle 76    These entries are available for those with permission to perform library preparation.
3706 19 Jan 16 olle 77    They are used to register and manage kit data for library preparation.
3706 19 Jan 16 olle 78
3706 19 Jan 16 olle 79  * Start DNA plate wizards:
3706 19 Jan 16 olle 80    These entries are available for those with permission to perform library preparation.
3706 19 Jan 16 olle 81    They are used to register DNA start plates for library preparation.
3706 19 Jan 16 olle 82
3190 18 Mar 15 olle 83  
2933 14 Nov 14 olle 84 == Compiling ==
2933 14 Nov 14 olle 85
2933 14 Nov 14 olle 86 To compile this package you also need:
2933 14 Nov 14 olle 87  
2933 14 Nov 14 olle 88  1. Ant 1.9
5540 04 Jul 19 olle 89  2. Java 11
2933 14 Nov 14 olle 90
2933 14 Nov 14 olle 91 Follow these instructions:
2933 14 Nov 14 olle 92
2933 14 Nov 14 olle 93  1. Download the source code from the subversion repository. See
2937 17 Nov 14 olle 94     http://baseplugins.thep.lu.se/wiki/net.sf.basedb.meludi for instructions.
2933 14 Nov 14 olle 95  
2933 14 Nov 14 olle 96  2. Type `ant download-lib` to automatically download the BASE core JAR files that
3028 11 Dec 14 olle 97     are needed for compilation. You can also do this manually by copying the 
2933 14 Nov 14 olle 98     base-*.jar files from the BASE installation directory 
2933 14 Nov 14 olle 99     (<basedir>/www/WEB-INF/lib/) to the ./lib/compile directory.
2933 14 Nov 14 olle 100
2937 17 Nov 14 olle 101  3. Type 'ant' to compile the code and generate the 'meludi.jar' file
2933 14 Nov 14 olle 102     in the project directory.
2933 14 Nov 14 olle 103
2933 14 Nov 14 olle 104  4. Use 'ant package' to create a downloadable tar.gz package.
2933 14 Nov 14 olle 105  
2933 14 Nov 14 olle 106 Tip: If you need different values for any of the properties defined in
2933 14 Nov 14 olle 107 the 'build.xml' file, create a file named 'build.properties' and set
2933 14 Nov 14 olle 108 the values there.

Generated on Tue Nov 21 03:27:26 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)