Skip to content

Commit 396b80d

Browse files
committed
Update installation guides for Linux and macOS with detailed steps and install location
1 parent 63d9a08 commit 396b80d

File tree

5 files changed

+393
-4
lines changed

5 files changed

+393
-4
lines changed

README.md

Lines changed: 373 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,373 @@
1-
# pymol-open-source-setup
1+
# Unofficial PyMOL(TM) Setup
2+
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-blue.svg)](https://GitHub.com/kullik01/pymol-open-source-setup/graphs/commit-activity)
3+
[![Python Version](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/)
4+
[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
5+
[![GitHub issues](https://img.shields.io/github/issues/kullik01/pymol-open-source-setup)](https://GitHub.com/kullik01/pymol-open-source-setup/issues/)
6+
7+
### Supported Platforms
8+
9+
![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)
10+
![macOS](https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=macos&logoColor=F0F0F0)
11+
![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
12+
13+
This repository offers **unofficial** setups/packages for the open-source version of PyMOL(TM)
14+
for **all major** operating systems.
15+
16+
## <img src='https://github.com/primer/octicons/blob/main/icons/download-24.svg' width='32'/> [Quick Installation](https://kullik01.github.io/pymol-open-source-setup/)
17+
18+
## Contents of this document
19+
* [About PyMOL](#About-PyMOL)
20+
* [Contents of this repository](#Contents-of-this-repository)
21+
* [Scripts](#Scripts)
22+
* [From source](#From-source)
23+
* [Prerequisites](#Prerequisites)
24+
* [Step-by-step guide](#Step-by-step-guide)
25+
* [License](#License)
26+
* [Acknowledgements](#Acknowledgements)
27+
<!--* [References and useful links](#References-and-useful-links) -->
28+
29+
## About PyMOL
30+
[PyMOL™](https://pymol.org/) is a powerful visualization software for rendering and animating 3D molecular structures. PyMOL is a trademark of Schrödinger, LLC.
31+
32+
Please note that the files provided here are **unofficial**. They are informal, unrecognized, and unsupported, offered for testing and evaluation purposes only. No warranty or liability is provided, and the software is made available "as-is."
33+
34+
## Contents of this repository
35+
"Insert some more information here"
36+
37+
## From source
38+
The following information is about building a platform dependent package/setup from source.
39+
40+
### Prerequisites for Windows
41+
- Inno Setup compiler 6
42+
- Install location must be: `C:\Program Files (x86)\Inno Setup 6\ISCC.exe`
43+
44+
### Prerequisites for Linux
45+
- Ruby (**only** if fpm is used for packaging)
46+
- apt (Debian or Ubuntu): `sudo apt-get install ruby-full`
47+
- yum (CentOS, Fedora, or RHEL): `sudo yum install ruby`
48+
49+
### Step-by-step guide
50+
1. Create a new Python virtual environment
51+
2. Install build dependencies using the requirements.txt of your platform
52+
3. Build the app package:
53+
54+
#### Windows
55+
If you are on Windows run:
56+
```shell
57+
.\win_automator.bat build app
58+
```
59+
```shell
60+
.\win_automator.bat build inno_setup
61+
```
62+
63+
#### macOS
64+
If you are on macOS:
65+
```shell
66+
chmod +x ./automator.sh && ./automator.sh build app
67+
```
68+
To build the DMG use a tool like [create-dmg](https://github.com/create-dmg/create-dmg) or fork the repository
69+
and run the GitHub action build_app.yaml.
70+
71+
#### Linux
72+
If you are on Linux:
73+
```shell
74+
chmod +x ./automator.sh && ./automator.sh build app
75+
```
76+
To build the tar.gz run:
77+
```shell
78+
mkdir -p packaged/build/Open-Source-PyMOL-<version-number>
79+
cp -r ./dist/exe.linux*/* packaged/build/Open-Source-PyMOL-<version-number>/
80+
mkdir -p packaged/bin
81+
tar czvf packaged/bin/Open-Source-PyMOL-<version-number>.tar.gz packaged/build/Open-Source-PyMOL-<version-number>
82+
```
83+
If you want to build a .deb or .rpm package, you could use the Ruby gem called fpm:
84+
```shell
85+
sudo gem install fpm
86+
mkdir -p package-root/opt/Open-Source-PyMOL-<version-number>
87+
cp -r ./dist/exe.linux*/* package-root/opt/Open-Source-PyMOL-<version-number>/
88+
mkdir -p package-root/usr/bin
89+
ln -s /opt/Open-Source-PyMOL-<version-number>/Open-Source-PyMOL package-root/usr/bin/Open-Source-PyMOL
90+
mkdir -p package-root/usr/share/applications
91+
cp os_specific/linux/open-source-pymol.desktop package-root/usr/share/applications
92+
93+
fpm -s dir -t deb \
94+
-n open-source-pymol \
95+
-v <version-number> \
96+
-a amd64 \
97+
-C package-root \
98+
--description "PyMOL installation for debian-based distros" \
99+
--license "BSD-3-Clause" \
100+
```
101+
102+
## License
103+
Copyright (c) [Schrodinger, LLC](https://www.schrodinger.com/)
104+
105+
Published under a BSD-like license, see [LICENSE](LICENSE).
106+
107+
## Acknowledgements
108+
**Schrödinger** for being the driving force behind the continued development of PyMOL after Warren's passing, ensuring that the open-source version remained alive and well.
109+
110+
**NOTE**: the following list has not been updated since Fall 2003 and was originally created by Warren himself.
111+
112+
Since then, the PyMOL effort has grown to such an extent that it is no longer
113+
practical to recognize everyone individually. Fortunately, a public
114+
record of participation exists and can be appreciated on the internet,
115+
and especially via the PyMOL mailing list archives. Suffice it to say
116+
that the PyMOL user community now numbers well into the thousands and
117+
includes scientists, students, and educators worldwide, spread
118+
throughout academia and the biotechnology and pharmaceutical
119+
industries. Though DeLano Scientific LLC specifically supports and
120+
maintains the PyMOL code base, the project can only continue to
121+
succeed through the sponsorship and participation of the broader
122+
community.
123+
124+
**Founder and Principal Author**:
125+
126+
Warren L. DeLano
127+
128+
Major Authors (5000+ lines of code):
129+
130+
Ralf W. Grosse-Kunstleve (SGLite Module)
131+
132+
Minor Authors (500+ lines of code):
133+
134+
Scott Dixon (Metaphorics CEX support)
135+
Filipe Maia (Slice Objects)
136+
137+
Other Contributors: These are the people who have gone out of
138+
their way to help the project with their ideas, actions,
139+
advice, hardware donations, testing, information, sponsorship,
140+
peer support, or code snippets.
141+
142+
Daan van Aalten
143+
Paul Adams
144+
Stephen Adler
145+
Jun Aishima
146+
Dennis Allison
147+
Ricardo Aparicio
148+
Daniel Appelman
149+
Diosdado "Rey" Banatao
150+
Michael Banck
151+
Ulrich Baumann
152+
Joseph Becker
153+
Balaji Bhyravbhatla
154+
Jeff Bizzaro
155+
Jeff Blaney
156+
Juergen Bosch
157+
Michael Bower
158+
Sarina Bromberg
159+
Axel Brunger
160+
Robert Campbell
161+
Bronwyn Carlisle
162+
Duilio Cascio
163+
Julien Chiron
164+
Shawn Christensen
165+
Scott Classen
166+
David Cooper
167+
Larry Coopet
168+
Jacob Corn
169+
Ben Cornett
170+
Andrew Dalke
171+
Koen van der Drift
172+
Harry Dailey
173+
Byron DeLaBarre
174+
Bill DeGrado
175+
Thomas Earnest
176+
Nathaniel Echols
177+
John Eksterowicz
178+
Erik Evensen
179+
David Fahrney
180+
Tim Fenn
181+
Thierry Fischmann
182+
Michael Ford
183+
Esben Peter Friis
184+
Kevin Gardner
185+
R. Michael Garavito
186+
John Gerig
187+
Jonathan Greene
188+
Michael Goodman
189+
Joel Harp
190+
Reece Hart
191+
Richard Hart
192+
Peter Haebel
193+
Matt Henderson
194+
Douglas Henry
195+
Possu Huang
196+
Uwe Hoffmann
197+
Jenny Hinshaw
198+
Carly Huitema
199+
Bjorn Kauppi
200+
Greg Landrum
201+
Robert Lawrence Kehrer
202+
Tom Lee
203+
Eugen Leitl
204+
Ken Lind
205+
Jules Jacobsen
206+
Luca Jovine
207+
Andrey Khavryuchenko
208+
David Konerding
209+
Greg Landrum
210+
Michael Love
211+
Tadashi Matsushita
212+
Genevieve Matthews
213+
Gerry McDermott
214+
Robert McDowell
215+
Gustavo Mercier
216+
Naveen Michaud-Agrawal
217+
Aaron Miller
218+
Holly Miller
219+
Tim Moore
220+
Kelley Moremen
221+
Hideaki Moriyama
222+
Nigel Moriarty
223+
Geoffrey Mueller
224+
Cameron Mura
225+
Florian Nachon
226+
Hanspeter Niederstrasser
227+
Michael Nilges
228+
Hoa Nguyen
229+
Shoichiro Ono
230+
Chris Oubridge
231+
Andre Padilla
232+
Jay Pandit
233+
Ezequiel "Zac" Panepucci
234+
Robert Phillips
235+
Hans Purkey
236+
Rama Ranganathan
237+
Michael Randal
238+
Daniel Ricklin
239+
Ian Robinson
240+
Eric Ross
241+
Kristian Rother
242+
Marc Saric
243+
Bill Scott
244+
Keana Scott
245+
Denis Shcherbakov
246+
Goede Schueler
247+
Paul Sherwood
248+
Ward Smith
249+
John Somoza
250+
David van der Spoel
251+
Paul Sprengeler
252+
Matt Stephenson
253+
Peter Stogios
254+
John Stone
255+
Charlie Strauss
256+
Michael Summers
257+
Brian Sutton
258+
Hanna and Abraham Szoke
259+
Rod Tweten
260+
Andras Varadi
261+
Scott Walsh
262+
Pat Walters
263+
Mark White
264+
Michael Wilson
265+
Dave Weininger
266+
Chris Wiesmann
267+
Charles Wolfus
268+
Richard Xie
269+
270+
Miscellaneous Code Snippets Lifted From:
271+
272+
Thomas Malik (fast matrix-multiply code)
273+
John E. Grayson (Author of "Python and Tkinter")
274+
Doug Hellmann (Wrote code that JEG later modified.)
275+
276+
Open-Source "Enablers" (essential, but not directly involved):
277+
278+
Brian Paul (Mesa)
279+
Mark Kilgard (GLUT)
280+
Guido van Rossum (Python)
281+
Linus Torvalds (Linux Kernel)
282+
283+
Precision Insight (DRI)
284+
The XFree86 Project (Free Windowing System)
285+
VA Linux (CVS Hosting)
286+
Richard Stallman/Free Software Foundation (GNU Suite)
287+
The unknown authors of EISPACK (Linear Algebra)
288+
289+
Graphics Technology "Enablers" (essential!)
290+
291+
3dfx (RIP)
292+
nVidia
293+
ATI
294+
295+
### Specific Acknowledgments:
296+
297+
* Thanks to Joni W. Lam for making the business work.
298+
299+
* Thanks to John Stone and John Furr for being such excellent
300+
colleagues.
301+
302+
* Thanks to Ragu Bharadwaj and Marcin Joachimiak for Java expertise
303+
and encouragement.
304+
305+
* Thanks to Apple Computer for continued encouragement, assistance,
306+
and HLAs in support of Mac development. Thanks especially to
307+
Robert Kehrer for creating so many fun opportunities over the years.
308+
309+
* Thanks to Aaron Miller (GlaxoSmithKline) for a continuous stream of
310+
thoughtful opinions and suggestions.
311+
312+
* Thanks to Dave Weininger for suggesting the "roving" feature and for
313+
being such an inspirational friend and mentor.
314+
315+
* Thanks to Matt Hahn and Dave Rogers for proving that it can also be
316+
done, again.
317+
318+
* Thanks to Mick Savage for providing experienced practical advice on
319+
the marketing of scientific software.
320+
321+
* Thanks to Ian Matthew for 3D experience and perspective.
322+
323+
* Thanks for Jeff Blaney for numerous insightful discussions.
324+
325+
* Thanks to Elizabeth Pehrson for making this a team effort.
326+
327+
* Thanks to Erin Bradley for schooling in focus and vision.
328+
329+
* Thanks to Vera Povolona for catalytic clarity and introspection.
330+
331+
* Thanks to Anthony Nichols for proving that it can be done, yet again.
332+
333+
* Thanks to Thompson Doman for timely Open-Source validation.
334+
335+
* Thanks to Manfred Sippl for making it all seem so simple.
336+
337+
* Thanks to Kristian Rother for all his excellent work building on the
338+
PyMOL foundation, and in helping others learn to use the software.
339+
340+
* Thanks to Dave Weininger, Scott Dixon, Roger Sayle, Andrew Dalke,
341+
Anthony Nichols, Dick Cramer, and David Miller, as well as rest of
342+
the Daylight and OpenEye teams for thoughtful discussions on PyMOL
343+
and open-source software during my 2002 pilgrimage to Sante Fe, NM.
344+
345+
* Thanks to Ralf Grosse-Kunstleve for his contribution of the "sglite"
346+
space group and symmetry handling module.
347+
348+
* Thanks to the scientists and management of Sunesis Pharmaceuticals
349+
for supporting PyMOL development since program inception.
350+
351+
* Thanks to the Computational Crystallography Initiative (LBNL)
352+
developers for their encouragement, ideas, and support.
353+
354+
* Thanks to Scott Walsh for being the first individual to provide
355+
financial support for PyMOL.
356+
357+
* Thanks to the hundreds of individuals, companies, and institutions
358+
that have provided financial support for the project.
359+
360+
* Thanks to Brian Paul and the Precision Insight team for development
361+
of Mesa/DRI which greatly assisted in the early development of PyMOL.
362+
363+
* Thanks to Michael Love for the first major outside port of PyMOL
364+
(to GNU-Darwin/OSX) and for believing in the cause.
365+
366+
* Thanks for Paul Sherwood for making a concerted effort to develop
367+
using PyMOL long before the software and vision had matured.
368+
369+
* Thanks to Jay Ponder for thoughtful email discussions on Tinker and
370+
the role of open-source scientific software.
371+
372+
* Thanks to hundreds of PyMOL users for the many forms of feedback,
373+
bug sightings, and encouragement they've provided.
1.49 MB
Loading

docs/website/docs/install_linux.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
There are three different packages available to install
33
Open-Source PyMOL under Linux.
44

5+
Install location: `/opt/open-source-pymol`
6+
57
## Debian-based distros (Ubuntu, PopOS!)
68
To install the DEB package, run the following command:
79
```shell

0 commit comments

Comments
 (0)