| 1 | <html>
|
|---|
| 2 | <!--
|
|---|
| 3 | === UCSF ChimeraX Copyright ===
|
|---|
| 4 | Copyright 2016 Regents of the University of California.
|
|---|
| 5 | All rights reserved. This software provided pursuant to a
|
|---|
| 6 | license agreement containing restrictions on its disclosure,
|
|---|
| 7 | duplication and use. For details see:
|
|---|
| 8 | http://www.rbvi.ucsf.edu/chimerax/docs/licensing.html
|
|---|
| 9 | This notice must be embedded in or attached to all copies,
|
|---|
| 10 | including partial copies, of the software or any revisions
|
|---|
| 11 | or derivations thereof.
|
|---|
| 12 | === UCSF ChimeraX Copyright ===
|
|---|
| 13 | -->
|
|---|
| 14 |
|
|---|
| 15 | <head>
|
|---|
| 16 | <link rel="stylesheet" type="text/css" href="../userdocs.css" />
|
|---|
| 17 | <title>Command: devel</title>
|
|---|
| 18 | <style>
|
|---|
| 19 | @media (prefers-color-scheme: dark) {
|
|---|
| 20 | :root {
|
|---|
| 21 | color-scheme: dark;
|
|---|
| 22 | }
|
|---|
| 23 | }
|
|---|
| 24 | </style>
|
|---|
| 25 | </head>
|
|---|
| 26 | <body>
|
|---|
| 27 | <a name="top"></a>
|
|---|
| 28 | <a href="../index.html">
|
|---|
| 29 | <img
|
|---|
| 30 | width="60px"
|
|---|
| 31 | src="../ChimeraX-docs-icon.svg"
|
|---|
| 32 | alt="ChimeraX docs icon"
|
|---|
| 33 | class="clRighticon"
|
|---|
| 34 | title="User Guide Index"
|
|---|
| 35 | /></a>
|
|---|
| 36 |
|
|---|
| 37 | <h3><a href="../index.html#commands">Command</a>: devel</h3>
|
|---|
| 38 | <p>
|
|---|
| 39 | The <b>devel</b> command builds and installs ChimeraX bundles. Alone it is
|
|---|
| 40 | an incomplete command; it must be entered as one of its subcommands:
|
|---|
| 41 | </p>
|
|---|
| 42 | <ul>
|
|---|
| 43 | <li>
|
|---|
| 44 | <a href="#alias"><b>devel alias</b></a>
|
|---|
| 45 | </li>
|
|---|
| 46 | <li>
|
|---|
| 47 | <a href="#build"><b>devel build</b></a>
|
|---|
| 48 | </li>
|
|---|
| 49 | <li>
|
|---|
| 50 | <a href="#clean"><b>devel clean</b></a>
|
|---|
| 51 | </li>
|
|---|
| 52 | <li>
|
|---|
| 53 | <a href="#dump"><b>devel dump</b></a>
|
|---|
| 54 | </li>
|
|---|
| 55 | <li>
|
|---|
| 56 | <a href="#install"><b>devel install</b></a>
|
|---|
| 57 | </li>
|
|---|
| 58 | <li>
|
|---|
| 59 | <a href="#pip"><b>devel pip</b></a>
|
|---|
| 60 | </li>
|
|---|
| 61 | <li>
|
|---|
| 62 | <a href="#unalias"><b>devel unalias</b></a>
|
|---|
| 63 | </li>
|
|---|
| 64 | </ul>
|
|---|
| 65 | <a href="#top" class="nounder">•</a>
|
|---|
| 66 | <a name="alias"></a>
|
|---|
| 67 | <b>devel alias</b> [ <b>name</b> [ <i>path</i> ] ]
|
|---|
| 68 | <blockquote>
|
|---|
| 69 | With no arguments, list the defined aliases. If <b>name</b> is given, list
|
|---|
| 70 | the aliases for <b>name</b>. If both <b>name</b> and <b>path</b> are
|
|---|
| 71 | given, record <b>name</b> as an alias for <b>path</b>. If another path is
|
|---|
| 72 | entered for the same name, the new path will replace the old one under the
|
|---|
| 73 | same name.
|
|---|
| 74 | </blockquote>
|
|---|
| 75 |
|
|---|
| 76 | <a href="#top" class="nounder">•</a>
|
|---|
| 77 | <a name="build"></a>
|
|---|
| 78 | <b>devel build</b> <i>path</i> [ <b>debug</b> true | <b>false</b> ] [
|
|---|
| 79 | <b>exit</b> true | <b>false</b> ]
|
|---|
| 80 | <blockquote>
|
|---|
| 81 | Build the bundle at <b>path</b>. If <b>debug</b> is true, any compiled
|
|---|
| 82 | extensions are built with debugging information. If <b>exit</b> is true,
|
|---|
| 83 | then ChimeraX will quit upon this command's completion.
|
|---|
| 84 | </blockquote>
|
|---|
| 85 |
|
|---|
| 86 | <a href="#top" class="nounder">•</a>
|
|---|
| 87 | <a name="clean"></a>
|
|---|
| 88 | <b>devel clean</b> <i>path</i> [ <b>exit</b> true | <b>false</b> ]
|
|---|
| 89 | <blockquote>
|
|---|
| 90 | Remove build files from <b>path</b>. If <b>exit</b> is true, then ChimeraX
|
|---|
| 91 | will quit upon this command's completion.
|
|---|
| 92 | </blockquote>
|
|---|
| 93 |
|
|---|
| 94 | <a href="#top" class="nounder">•</a>
|
|---|
| 95 | <a name="dump"></a>
|
|---|
| 96 | <b>devel dump</b> <i>path</i>
|
|---|
| 97 | <blockquote>
|
|---|
| 98 | Log the metadata for the bundle at <b>path</b> as determined by ChimeraX.
|
|---|
| 99 | </blockquote>
|
|---|
| 100 |
|
|---|
| 101 | <a href="#top" class="nounder">•</a>
|
|---|
| 102 | <a name="install"></a>
|
|---|
| 103 | <b>devel install</b> <i>path</i> [ <b>debug</b> true | <b>false</b> ] [
|
|---|
| 104 | <b>noDeps</b> true | <b>false</b> ] [ <b>user</b> true | <b>false</b> ] [
|
|---|
| 105 | <b>exit</b> true | <b>false</b> ] [ <b>editable</b> true | <b>false</b> ]
|
|---|
| 106 | <blockquote>
|
|---|
| 107 | Install the bundle at <b>path</b>, building it first if necessary. If
|
|---|
| 108 | <b>debug</b> is true, then any compiled extensions are built with
|
|---|
| 109 | debugging information. If <b>user</b> is true, the bundle is installed
|
|---|
| 110 | into the user's package directory instead of the internal ChimeraX
|
|---|
| 111 | directory. If <b>editable</b> is true, the bundle is installed so that
|
|---|
| 112 | changes to Python files take effect the next time ChimeraX restarts, but
|
|---|
| 113 | changes to metadata (bundle_info.xml or pyproject.toml) or to compiled
|
|---|
| 114 | extensions still require a reinstall. If <b>exit</b> is true, then
|
|---|
| 115 | ChimeraX will quit upon this command's completion.
|
|---|
| 116 | </blockquote>
|
|---|
| 117 |
|
|---|
| 118 | <a href="#top" class="nounder">•</a>
|
|---|
| 119 | <a name="pip"></a>
|
|---|
| 120 | <b>devel pip</b> [ <b>name</b> [ <i>path</i> ] ]
|
|---|
| 121 | <blockquote>
|
|---|
| 122 | This command is an alias for the <a href="../pip.html">pip</a> command.
|
|---|
| 123 | </blockquote>
|
|---|
| 124 |
|
|---|
| 125 | <a href="#top" class="nounder">•</a>
|
|---|
| 126 | <a name="unalias"></a>
|
|---|
| 127 | <b>devel unalias</b> <b>name</b>
|
|---|
| 128 | <blockquote>
|
|---|
| 129 | If <b>name</b> was previously used as an alias, delete it.
|
|---|
| 130 | </blockquote>
|
|---|
| 131 |
|
|---|
| 132 | <hr />
|
|---|
| 133 | <address>
|
|---|
| 134 | UCSF Resource for Biocomputing, Visualization, and Informatics / November
|
|---|
| 135 | 2024
|
|---|
| 136 | </address>
|
|---|
| 137 | </body>
|
|---|
| 138 | </html>
|
|---|
![[ChimeraX Issue Tracking System]](/trac/ChimeraX/chrome/site/ChimeraX-icon.svg){kind=icon}
