[cctbxbb] Documentation in CCTBX

[Dorothee Liebschner]

Hi James,

Thanks for mentioning the issue.

Maybe at this point, it would be good to collect all available
documentation/tutorials and list them in a centralized place (cctbx GitHub
doc?).

There was a thread on this bb in 2015 which listed some documentation:
http://www.phenix-online.org/pipermail/cctbxbb/2015-January/001042.html
(Unfortunately, http://cctbxwiki.bravais.net/CCTBX_Wiki, which is listed
there, seems to be offline...)

One could add maybe the cctbx newsletter articles and slides from workshops
(such as your slides/material from the ECM computing school?). If anyone
has additional suggestions for material, it would be good to add them to
this thread.

A list of material does not replace a proper documentation, but it could be
a starting point.

Best wishes,

Dorothee




On Mon, Sep 3, 2018 at 3:38 AM james.parkhurst at diamond.ac.uk <
james.parkhurst at diamond.ac.uk> wrote:

> Dear all,
>
> I recently attended the ECM computing school and gave some tutorials using
> cctbx. One of the comments that was pretty common was the lack of
> documentation in cctbx. In fact, a couple of people representing different
> groups said that the lack of documentation was a major reason for not using
> cctbx within their groups.
>
> We had a discussion about this and Andrea mentioned that it was (is?)
> possible in Germany to to apply for a grant to maintain mature software
> that would cover things like writing documentation. So if this is still
> possible, we might be able to apply for some money to employ someone for a
> period of time to do this.
>
> Anyway, given the number of comments I received about the lack of
> documentation, I thought it was worth raising the issue here.
>
> Best wishes
> James
>
>
>
> --
> This e-mail and any attachments may contain confidential, copyright and or
> privileged material, and are for the use of the intended addressee only. If
> you are not the intended addressee or an authorised recipient of the
> addressee please notify us of receipt by returning the e-mail and do not
> use, copy, retain, distribute or disclose the information in or attached to
> the e-mail.
> Any opinions expressed within this e-mail are those of the individual and
> not necessarily of Diamond Light Source Ltd.
> Diamond Light Source Ltd. cannot guarantee that this e-mail or any
> attachments are free from viruses and we cannot accept liability for any
> damage which you may sustain as a result of software viruses which may be
> transmitted in or with the message.
> Diamond Light Source Limited (company no. 4375679). Registered in England
> and Wales with its registered office at Diamond House, Harwell Science and
> Innovation Campus, Didcot, Oxfordshire, OX11 0DE, United Kingdom
>
>
> _______________________________________________
> cctbxbb mailing list
> cctbxbb at phenix-online.org
> http://phenix-online.org/mailman/listinfo/cctbxbb
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://phenix-online.org/pipermail/cctbxbb/attachments/20180906/a6c64818/attachment.htm>