Difference between revisions of "Main Page"

From mx Help Wiki
Jump to: navigation, search
 
(88 intermediate revisions by 18 users not shown)
Line 1: Line 1:
<div style="float: right; margin: 0em 1em 1em 1em; padding: 0em 1em 1em 1em;">__TOC__</div>
 
== mx ==
 
  
<p>  Welcome to the home of the mx ('m'atri'x', yes we're considering other names ) project. </p>
 
  
<p>mx is a collaborative on-line (completely web-based) content management system for evolutionary systematists, particularly those working on descriptive taxonomy. The project is in active development, with features being added as needed to those using the system.</p>
+
<div style="padding:1em;border:1px solid red;margin:1em;">
 +
<p> The codebase of Mx will being rolled into a new initiative from the Species File Group, [http://taxonworks.org TaxonWorks]. Contact --[[User:Matt|matt]] ([[User talk:Matt|talk]]) 10:06, 25 March 2013 (CDT) if you have questions, or would like to join this effort. Details and resources to follow in May, 2013. </p>
 +
</div>
  
<p>The long term goals of mx are as follows:
 
  
* the desire to ultimately capture all data pertinent to a modern taxonomic revision (including phylogenetic data) during the revisionary process such that simultaneous publication of all data in print and electronic forms is possible
 
* the development of a web-based multi-user front end whose components may also be used (or translated relatively seamlessly) for public display of data
 
* the implementation of a taxon-concept based OTU ('O'perational 'T'axonomic 'U'nit) as the core data object, such that published and unpublished (working) concepts can be managed
 
* the use of freely available software (including the mx sourcecode) in an aggressively open-source framework
 
</p> <br/>
 
  
== What's it being used for? ==
+
<div style="padding:1em;border:1px solid orange;margin:1em;"> <p> The content here is becoming dated, but is largely accurate for the (very-stable) SVN-archived version of mx on Sourceforge (edge branch) that uses Rails version  2.3.18. </p>
  
<p>mx presently handles a wide range of data. Researchers are presently using it to manage morphological matrices, specimen and sequence data, references, taxonomic descriptions, bifurcating and multi-entry keys, biological associations, images, collecting events, taxonomic hierarchies and more. The database currently has both private and public front ends, each of which are web based.  Search forms or other public accessible components can be wrapped is different layouts relatively easily.  To share data with the rest of the world we will be using [http://trac.pywrapper.org/ pyWrapper], which we are working on configuring now. </p>
+
<p> Ongoing development and updates are now on [http://github.com/mx3 GitHub]. Please also join the new [https://groups.google.com/forum/?fromgroups#!forum/mx-developers developers list]. </p> </div>
<br/>
+
<gallery>
+
Image:SS_Shot_1.jpg|Manage OTUs
+
Image:SS_Shot_8.jpg|Manage matrices
+
Image:SS_Shot_18.jpg|Manage images (or link to [http://www.morphbank.net MorphBank])
+
Image:SS_Shot_12.jpg|Compose descriptions
+
</gallery>
+
<br/>
+
  
=== Projects accessible to public ===
 
  
Note that the data for all of these projects are served by a single instance of mx.
+
== Welcome to the homepage for mx ==
 +
<p> mx (preferred reference all lowercase) is a Ruby-based platform that consists of a Ruby on Rails (RoR) application and various supporting gems/libraries. Initially conceived and developed as a collaborative web-based content management system for biosystematists mx now has a wide range of functionality much of which can broadly categorized under the umbrella of biodiversity informatics.</p>
 +
<p> mx is a relatively flexible codebase as highlighted by some of its more utilized functionality: </p>
  
* [http://evaniid.tamu.edu  Catalogous Evaniidorum]
+
* Ontologies - A wide range of functionality for creating and develop ontologies (e.g. anatomical) that are exportable to OBO formats
* [http://www.diapriid.org  The Diapriidae]
+
* Phylogenetic matrices - A wide range of support for matrix development, including much utility coding very large matrices (e.g. 1000x1000)
* [http://hymglossary.tamu.edu  Hymenoptera Glossary] and see [http://ceb.scs.fsu.edu/ronquistlab/ontology/wiki/index.php/Main_Page the wiki for that project] and the [[API discussion]] link for discussion on how we might make the ontology more interactive.
+
* Specimen metadata - Museum level specimen curation ''very simple IPT integration coming Spring 2011''
* [http://www.amentinst.org  The American Entomological Institute]
+
* DNA workbench - Audit trails from specimen to sequence including generation of PCR worksheets and FASTA import
* [http://hymenoptera.tamu.edu/rna The jRNA Website] (Reference/Citation management)
+
* Taxonomic catalogs - Data managed, updated, then presentable to then exportable to various formats (e.g. ITIS)
<br/>
+
* Taxon pages/treatments - Customize templates then add dynamic (e.g. matrix based descriptions) or text content and figures
 +
* Biological associations - For example- cataloging host-parasite records
 +
* Multiple-entry and bifurcating keys
  
=== Screenshots ===
+
<p> Features are additionally highlighted in [[Features | this summary]]. </p>
 +
<p> Highlights of some things that makes mx special: </p>
 +
 +
* Multi-user, multi-project support in one installation
 +
* A universal tagging system for workflow management or annotations
 +
* Implementation of an OTU ('O'perational 'T'axonomic 'U'nit) as a core data object- this cleanly separates content from nomenclature
 +
* A completely open-source based approach, code updates are not squirreled away until research is published
  
<p> Researchers use a private set of forms to enter and manage their data, see these [[Screen_Shots | screen shots]].</p>
+
== How do I use it? ==
<br/>
+
  
== Publications ==
+
There are two general paths:
 +
# Find someone who is hosting a installation of mx and ask them to create a project for you.
 +
# Install your own instance and create your own projects.  See [[Installation]] and the FAQ for more on this option.
  
*<p>Yoder, M.J. 2007.  Mannomicrus (Hymenoptera: Diapriidae), a new genus of myrmecophilic diapriid, with a digital version of Masner and Garcia's (2002) key to New World Diapriinae and an illustration of digital description and key markup using an ontology. Zootaxa 1439: 47-55 [http://www.mapress.com/zootaxa/2007f/zt01439p055.pdf pdf]</p>
+
== The hack-mx workshop ==
  
*<p>Yoder, M.J. 2007. Collaboration in systematic biology. TAMU Dept. of Entomology Seminar Series.</p>
+
In October, 2011 a hack-mx workshop was held for people with a wide range of programming experience (from none, to expert). Download the tutorials/exercises that were used [http://www.phenomix.org/phenomix/hack-mx_tutorials/hack-mx_tutorials.zip here] (.zip, remote site).
  
*<p>Deans, A.R. and Yoder, M.J. 2006. Ontologizing morphological terms for Hymenoptera - implementing and benefiting from a controlled vocabulary.  Entomological Society of America. Indianapolis, IN.</p>
+
<div style="font-size: larger; padding: 1em; text-align: center; width: 80%; margin-left: auto;margin-right: auto; border-top: 1px dotted silver;">  
 +
[[Public projects| projects with public data]] | [[Publications| publications etc.]] | [[Roadmap | roadmap]] | [[Credit | credit]] | [[Funding | funding/support]] </div>
  
*<p>Yoder, M.J., Dole, K, Deans, A. 2006. Introducing 'mx', a sharable digital workbench for systematic biologists.  Taxonomic Databases Working Group 2006 Annual Meeting</p>
+
__NOTOC__
 
+
*<p>Yoder, M.J. 2006. 'mx' - A digital workbench for evolutionary systematists.  TAMU Dept. of Entomology Annual Graduate Student Forum</p>
+
<br/>
+
 
+
== Why use mx? ==
+
We've started a [[Why use mx | list of reasons for and against using mx here]].
+
 
+
<br/>
+
 
+
== How do I get it? ==
+
=== Source ===
+
 
+
* A typically slightly dated copy of the source is presently available [http://sourceforge.net/projects/mx-database from Sourceforge]. Developers are currently using SVN to manage sourcecode, but the SVN repository is not yet on Sourceforge.  If you are interested in developing via SVN contact us. 
+
*  Bug tracking, feature requests etc. are also available at Sourceforge.
+
 
+
<br/>
+
 
+
=== Installation ===
+
Instructions for installation can be found [[Installation | here]].
+
<br/><br/>
+
 
+
== Credit ==
+
 
+
mx is coded by Matt Yoder and Krishna Dole with help from Andy Deans.  Johan Lijleblad and Katja Seltmann have provided documentation and much useful feedback. Many others, in particular the Wharton (TAMU), Cognato (MSU), and Heraty (UCR) labs have provided feedback.  We are very open to having others join us. <br/>
+
 
+
Various previous projects influenced the development of mx, in particular:
+
* The table structure for specimens and collecting event related data is loosely based on the TAMUIC insect collection's database programmed by Yoder and Oswald.  That database was in turn loosely based on a very early draft (pre 1998) of the [http://www.specifysoftware.org Specify] table structure. 
+
* Some of the tables containing matrix related data are based on Yoder's early MS Access database mtrx, which was greatly simplified from Gregor Hagedorn's software Delta Access (apparently no longer available on-line, but see [http://freedelta.sourceforge.net/ here]).
+
* We presently have some tables that have not been developed (i.e. we have no working front end) that are very loosely based on the [http://www.ncbi.nlm.nih.gov/entrez/query.fcgi?cmd=Retrieve&db=PubMed&list_uids=15545259&dopt=Abstract Metacanthomorpha database.]
+
<br/>
+
== Support ==
+
 
+
Activities relating to the development and promotion of mx have been funded directly or indirectly by the following sources:
+
 
+
* NSF PEET Grant DEB-0328922 to Dr. Bob Wharton
+
* A Texas A&M Ecology and Evolutionary Biology Graduate Student Travel Grant to Matt Yoder
+
* A great resource for information on curved sectional couches:
+
* [http://getanswerz.com/homegarden/decorating/curved-sectional-couches-finding-slipcovers/ Curved Sectional Couches]
+

Latest revision as of 11:41, 3 April 2014


The codebase of Mx will being rolled into a new initiative from the Species File Group, TaxonWorks. Contact --matt (talk) 10:06, 25 March 2013 (CDT) if you have questions, or would like to join this effort. Details and resources to follow in May, 2013.


The content here is becoming dated, but is largely accurate for the (very-stable) SVN-archived version of mx on Sourceforge (edge branch) that uses Rails version 2.3.18.

Ongoing development and updates are now on GitHub. Please also join the new developers list.


[edit] Welcome to the homepage for mx

mx (preferred reference all lowercase) is a Ruby-based platform that consists of a Ruby on Rails (RoR) application and various supporting gems/libraries. Initially conceived and developed as a collaborative web-based content management system for biosystematists mx now has a wide range of functionality much of which can broadly categorized under the umbrella of biodiversity informatics.

mx is a relatively flexible codebase as highlighted by some of its more utilized functionality:

  • Ontologies - A wide range of functionality for creating and develop ontologies (e.g. anatomical) that are exportable to OBO formats
  • Phylogenetic matrices - A wide range of support for matrix development, including much utility coding very large matrices (e.g. 1000x1000)
  • Specimen metadata - Museum level specimen curation very simple IPT integration coming Spring 2011
  • DNA workbench - Audit trails from specimen to sequence including generation of PCR worksheets and FASTA import
  • Taxonomic catalogs - Data managed, updated, then presentable to then exportable to various formats (e.g. ITIS)
  • Taxon pages/treatments - Customize templates then add dynamic (e.g. matrix based descriptions) or text content and figures
  • Biological associations - For example- cataloging host-parasite records
  • Multiple-entry and bifurcating keys

Features are additionally highlighted in this summary.

Highlights of some things that makes mx special:

  • Multi-user, multi-project support in one installation
  • A universal tagging system for workflow management or annotations
  • Implementation of an OTU ('O'perational 'T'axonomic 'U'nit) as a core data object- this cleanly separates content from nomenclature
  • A completely open-source based approach, code updates are not squirreled away until research is published

[edit] How do I use it?

There are two general paths:

  1. Find someone who is hosting a installation of mx and ask them to create a project for you.
  2. Install your own instance and create your own projects. See Installation and the FAQ for more on this option.

[edit] The hack-mx workshop

In October, 2011 a hack-mx workshop was held for people with a wide range of programming experience (from none, to expert). Download the tutorials/exercises that were used here (.zip, remote site).


Personal tools