ChimeraX-ScholAR/bundle_info.xml at main · RBVI/ChimeraX-ScholAR · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<!--
=== UCSF ChimeraX Copyright ===
Copyright 2024 Regents of the University of California. All rights reserved.
The ChimeraX application is provided pursuant to the ChimeraX license
agreement, which covers academic and commercial uses. For more details, see
<https://www.rbvi.ucsf.edu/chimerax/docs/licensing.html>

You can also
redistribute and/or modify it under the terms of the GNU Lesser General
Public License version 2.1 as published by the Free Software Foundation.
For more details, see
<https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html>

THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. ADDITIONAL LIABILITY
LIMITATIONS ARE DESCRIBED IN THE GNU LESSER GENERAL PUBLIC LICENSE
VERSION 2.1

This notice must be embedded in or attached to all copies, including partial
copies, of the software or any revisions or derivations thereof.
=== UCSF ChimeraX Copyright ===
-->

<BundleInfo name="ChimeraX-ScholAR"
	    version="1.0" package="chimerax.scholar"
  	    minSessionVersion="1" maxSessionVersion="1" customInit="true">

  <Author>UCSF RBVI</Author>
  <Email>[email protected]</Email>
  <URL>https://www.rbvi.ucsf.edu/chimerax/</URL>

  <!-- Synopsis is a one-line description
       Description is a full multi-line description -->
  <Synopsis>Create augmented reality and web browser data augmentations for publication.</Synopsis>
  <Description>Create, edit, and export your ChimeraX models to Schol-AR's augmented reality projects. User interface
    and commands support project creation, augmentation creation, and augmentation editing capabilities.

  Find the tool in the Tools menu under General -> ScholAR.
  </Description>

  <!-- Categories is a list where this bundle should appear -->
  <Categories>
    <Category name="General"/>
  </Categories>

  <!-- Dependencies on other ChimeraX/Python packages -->
  <Dependencies>
    <Dependency name="ChimeraX-Core" version="~=1.4"/>
    <Dependency name="ChimeraX-UI" version="~=1.0"/>
  </Dependencies>

  <!-- Non-Python files that are part of package -->
  <DataFiles>
    <DataDir>docs</DataDir>
  </DataFiles>

  <ExtraFiles>
    <ExtraFile source="resources/images/scholarimage.png">resources/images/scholarimage.png</ExtraFile>
  </ExtraFiles>

  <Classifiers>
    <!-- Development Status should be compatible with bundle version number -->
    <PythonClassifier>Development Status :: 3 - Alpha</PythonClassifier>
    <PythonClassifier>License :: Freeware</PythonClassifier>
    <!-- ChimeraX classifiers describe supplied functionality -->
    <!-- Register a graphical interface tool -->
    <ChimeraXClassifier>ChimeraX :: Tool :: ScholAR ::
      General :: ChimeraX and Schol-AR interface</ChimeraXClassifier>

    <ChimeraXClassifier>ChimeraX :: Command :: scholar login :: General ::
      User login for scholar</ChimeraXClassifier>

    <ChimeraXClassifier>ChimeraX :: Command :: scholar project :: General ::
      Select an existing project or create a new one and set up file structure.</ChimeraXClassifier>

    <ChimeraXClassifier>ChimeraX :: Command :: scholar augmentation :: General ::
      Select an existing augmentation or create a new one and set up file structure. </ChimeraXClassifier>

    <ChimeraXClassifier>ChimeraX :: Command :: scholar downloadAugFiles :: General ::
      Download augmentation files from Schol-AR into the local directory structure. </ChimeraXClassifier>

    <ChimeraXClassifier>ChimeraX :: Command :: scholar uploadAugFiles :: General ::
      Upload augmentation files from the current session to the Schol-AR from the local directory structure. </ChimeraXClassifier>

    <ChimeraXClassifier>ChimeraX :: Command :: scholar downloadQR :: General ::
      Download the QR files associated with a project. </ChimeraXClassifier>

    <ChimeraXClassifier>ChimeraX :: Command :: scholar saveAugSession :: General ::
      Save a ChimeraX Session file to an augmentation. </ChimeraXClassifier>

    <ChimeraXClassifier>ChimeraX :: Command :: scholar openAugSession :: General ::
      Open a ChimeraX Session if there is one linked to an augmentation. </ChimeraXClassifier>

    <ChimeraXClassifier>ChimeraX :: Command :: scholar storeTargetImage :: General ::
      Copy the target image for an augmentation to an inputted file target. </ChimeraXClassifier>

    <ChimeraXClassifier>ChimeraX :: Command :: scholar storeModel :: General ::
      Copy the model file for an augmentation to an inputted file target. </ChimeraXClassifier>

    <ChimeraXClassifier>ChimeraX :: Command :: scholar storeAllAugFiles :: General ::
      Copy the all augmentation files for an augmentation to an inputted folder. </ChimeraXClassifier>

    <ChimeraXClassifier>ChimeraX :: Command :: scholar storeQRImage :: General ::
      Save the public QR code image to a location outside the Schol-AR directory structure. </ChimeraXClassifier>

    <ChimeraXClassifier>ChimeraX :: Command :: scholar cleanLocal :: General ::
      Clean all local files that are associated with projects or augmentations that no longer exist on Schol-AR. </ChimeraXClassifier>

    <ChimeraXClassifier>ChimeraX :: Command :: scholar removeUser :: General ::
      Remove a user from the Schol-AR directory structure. </ChimeraXClassifier>
  </Classifiers>

</BundleInfo>