========== GAVO DaCHS ========== :Author: Markus Demleitner :Email: gavo@ari.uni-heidelberg.de :Date: |date| The GAVO Data Center Helper Suite (DaCHS) is a publishing infrastructure for the Virtual Observatory, including a flexible component for ingesting and mapping data, integrated metadata handling with a publishing registry, and support for many VO protocols and standards. Documentation ============= DaCHS' documentation is now `maintained on github `_; formatted versions are `available on readthedocs `_ . Please file documentation bugs there; other contributions are always welcome. Reading guide ------------- You do not need to read all of the documentation to get started. Of the installation guide, you probably only need the first couple of pages. At least skim over the tutorial before starting out, though, so you know what's discussed in there to return when you have a particular sort of data at hand. When you get error messages you don't understand, check the “Hints on common problems”. When you have some funky litte requirement the solution for which is not immediately obvious, try the “How do I” document. If what you want is not covered, ask the authors. Always keep the reference under your pillow. Even the authors regularly go back there. Almost all RDs for the services at the `GAVO data center `_ are available for your inspection, and the element reference may help you locate those relevant to whatever you're trying to do. There's nothing wrong with lavishly copying from there. You can ignore the topic guides (booster grammars, preprocessing, anything else that might yet come) until you notice you need to read them. Deployment Options ------------------ * Installation and configuration (`install.html <./install.html>`_, `install.pdf <./install.pdf>`_, `install.rstx <./install.rstx>`_) -- this is for “conventional” installations, typically using an APT-based package manager or perhaps directly from source. * You can also run DaCHS (plus postgres) within Docker containers. See https://github.com/chbrandt/docker-dachs. For Data Center Operators ------------------------- * dachs command manpage (`dachs.1.html <./dachs.1.html>`_, `dachs.1.pdf <./dachs.1.pdf>`_, `dachs.1.rstx <./dachs.1.rstx>`_) * Tutorial on importing data (`tutorial.html <./tutorial.html>`_, `tutorial.pdf <./tutorial.pdf>`_, `tutorial.rstx <./tutorial.rstx>`_) * Reference (`ref.html <./ref.html>`_, `ref.pdf <./ref.pdf>`_, `ref.rstx <./ref.rstx>`_) * How do I? (`howDoI.html <./howDoI.html>`_, `howDoI.pdf <./howDoI.pdf>`_, `howDoI.rstx <./howDoI.rstx>`_) * Hints on common problems (`commonproblems.html <./commonproblems.html>`_, `commonproblems.pdf <./commonproblems.pdf>`_, `commonproblems.rstx <./commonproblems.rstx>`_) * Reference to elements and attributes in use in GAVO's data center (`elemref.html `_) Special Topics for Operators ---------------------------- * Guide to writing HTML templates (`templating.html <./templating.html>`_, `templating.pdf <./templating.pdf>`_, `templating.rstx <./templating.rstx>`_) * Guide to write booster grammars (`booster.html <./booster.html>`_, `booster.pdf <./booster.pdf>`_, `booster.rstx <./booster.rstx>`_) * Guide to preprocessing input files (`processors.html <./processors.html>`_, `processors.pdf <./processors.pdf>`_, `processors.rstx <./processors.rstx>`_) For VO Data Providers --------------------- * Checklist for data providers (`data_checklist.html <./data_checklist.html>`_, `data_checklist.pdf <./data_checklist.pdf>`_, `data_checklist.rstx <./data_checklist.rstx>`_) Library Documentation --------------------- * STC library documentation (`stc.html <./stc.html>`_, `stc.pdf <./stc.pdf>`_, `stc.rstx <./stc.rstx>`_) * ADQL library documentation (`adql.html <./adql.html>`_, `adql.pdf <./adql.pdf>`_, `adql.rstx <./adql.rstx>`_) * VOTable library documentation (`votable.html <./votable.html>`_, `votable.pdf <./votable.pdf>`_, `votable.rstx <./votable.rstx>`_) * VOTable library tapquery documentation (`tapquery.html <./tapquery.html>`_, `tapquery.pdf <./tapquery.pdf>`_, `tapquery.rstx <./tapquery.rstx>`_) DaCHS developer Documentation ----------------------------- * Epydoc-generated `API documentation <./apidoc>`_. Note, however, that none of this is, as yet, guaranteed stable API. Very little will be. The main purpose of this is to help understanding the code as it is; but of course you should tell us "I need this function in a stable API" when you do, and we promise to regard such requests with favor. * Development notes (`develNotes.html <./develNotes.html>`_, `develNotes.pdf <./develNotes.pdf>`_, `develNotes.rstx <./develNotes.rstx>`_) Software ======== To obtain the software (or parts of it), see http://soft.g-vo.org. Support ======= If you run a DaCHS server, please subscribe to the `DaCHS-users`_ mailing list. It is low volume (less than one mail a month), and you get to know when new releases come out. We'd also appreciate being able to alert our users in case a security hole should be discovered in the software (which has happened once in the past ten years). If you have questions regarding DaCHS, we'd appreciate if you subscribed and sent your question to the `DaCHS-support`_ list (if all support requests went on the list, we'd expect a volume of about one mail per day, but let's see). It has a public archive, and other users can profit from our (and your peers') answers, which is why we prefer the list to questions sent directly to gavo@ari.uni-heidelberg.de; these will of course still be answered. Material related to DaCHS and the VO in general is also published now and then on `GAVO's blog`_ Citation ======== If you want or need to reference DaCHS, I suppose you should be citing :bibcode:`2014A&C.....7...27D`. If you can't bring yourself to boosting an Elsevier journal's impact factor, you have my sympathies, and you're welcome to cite the (less informative, more difficult for bibstyles) ASCL entry at :bibcode:`2018ascl.soft04005D`. .. _DaCHS-users: http://lists.g-vo.org/cgi-bin/mailman/listinfo/dachs-users .. _DaCHS-support: http://lists.g-vo.org/cgi-bin/mailman/listinfo/dachs-support .. _GAVO's blog: https://blog.g-vo.org .. |date| date::