[chimerax-users] Resources to get started with toolshed development

[Tom Goddard]

Hi Florian,

  The ChimeraX Programming Manual describes how to package up a ChimeraX plugin (called a "bundle") for distribution on the Toolshed

	https://www.cgl.ucsf.edu/chimerax/docs/devel/index.html

specifically the Building and Distributing Bundles section

	https://www.cgl.ucsf.edu/chimerax/docs/devel/writing_bundles.html#bundle-sample-code <https://www.cgl.ucsf.edu/chimerax/docs/devel/writing_bundles.html#bundle-sample-code>

Some examples of ChimeraX Python code are at the ChimeraX Recipes web site

	https://rbvi.github.io/chimerax-recipes/

and Python functions ChimeraX provides are described in the programming manual

	https://www.cgl.ucsf.edu/chimerax/docs/devel/modules.html <https://www.cgl.ucsf.edu/chimerax/docs/devel/modules.html>

but you may also want to look at the ChimeraX Python code which is in the distribution

	Windows:	chimerax/bin/lib/site-packages/chimerax
	Linux:		chimerax/lib/python3.7/site-packages/chimerax
	Mac:		ChimeraX.app/Contents/lib/python3.7/site-packages/chimerax

To submit a bundle to toolshed the basic steps are to make the the file that describes the bundle called bundle_info.xml, run the ChimeraX command "devel install /path/to/my/bundle-code", that produces a wheel file that is the standard way Python modules are distirubuted, mybundle.whl, for example from PyPi, and then upload it to the ChimeraX app store called Toolshed by pressing the Sign In button (uses Google Account login), https://cxtoolshed.rbvi.ucsf.edu <https://cxtoolshed.rbvi.ucsf.edu/>.

  Send questions if you run into any troubles.

	Tom



> On Oct 12, 2020, at 7:37 AM, Florian Wernert <florian.wernert at univ-amu.fr> wrote:
> 
> Hi there,
> 
> I'm looking forward to integrate a processing algorithm I coded into a toolshed for ChimeraX.
> 
> Are there any available resources in order to get started with plugin/toolshed development for ChimeraX ?
> 
> Thanks,
> 
> Florian Wernert
> 
> 
> _______________________________________________
> ChimeraX-users mailing list
> ChimeraX-users at cgl.ucsf.edu
> Manage subscription:
> https://www.rbvi.ucsf.edu/mailman/listinfo/chimerax-users
> 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://plato.cgl.ucsf.edu/pipermail/chimerax-users/attachments/20201012/dd43b13b/attachment-0001.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: toolshed.png
Type: image/png
Size: 428371 bytes
Desc: not available
URL: <http://plato.cgl.ucsf.edu/pipermail/chimerax-users/attachments/20201012/dd43b13b/attachment-0001.png>