Skip to content

Commit 6bb37e0

Browse files
Update copyright year
1 parent 3a5ba11 commit 6bb37e0

28 files changed

Lines changed: 100 additions & 100 deletions

CheckPyModule.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/env python
22

3-
# OctaDist Copyright (C) 2019-2024 Rangsiman Ketkaew et al.
3+
# OctaDist Copyright (C) 2019-2026 Rangsiman Ketkaew et al.
44
#
55
# This program is free software: you can redistribute it and/or modify
66
# it under the terms of the GNU General Public License as published by

README_FIRST

Lines changed: 24 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,58 @@
11
###########################################################
2-
OctaDist Copyright (C) 2019-2024 Rangsiman Ketkaew et al.
2+
OctaDist Copyright (C) 2019-2026 Rangsiman Ketkaew et al.
33
###########################################################
44

5-
Program Info
6-
============
5+
# Program Info
76

87
program_name = OctaDist (Octahedral distortion calculator)
98
program_version = 3.1.0
109
program_release = 2024
1110

12-
Citation
13-
========
11+
# Citation
1412

1513
If your work has been done by OctaDist, please cite us as following
1614

17-
OctaDist - A tool for calculating distortion parameters in coordination complexes.
18-
https://octadist.github.io
15+
OctaDist - A tool for calculating distortion parameters in coordination complexes.
16+
https://octadist.github.io
1917

20-
Install and Run
21-
===============
18+
# Install and Run
2219

2320
1. Run "CheckPyModule.py" to check if your system has the python packages that required for OctaDist.
2421

25-
$ cd OctaDist-info_using_devinfo_using_dev-src-x86-64
26-
$ python CheckPyModule.py
22+
$ cd OctaDist-info_using_devinfo_using_dev-src-x86-64
23+
$ python CheckPyModule.py
2724

28-
If any required packages has not been installed, run command:
25+
If any required packages has not been installed, run command:
2926

30-
$ pip install -r requirements.txt
27+
$ pip install -r requirements.txt
3128

3229
2. Build source code
3330

34-
$ python setup.py build
35-
$ python setup.py install
36-
$ python setup.py test
31+
$ python setup.py build
32+
$ python setup.py install
33+
$ python setup.py test
3734

3835
3. Run OctaDist - GUI
3936

40-
$ octadist
37+
$ octadist
4138

4239
4. Run OctaDist - command line
4340

44-
$ octadist_cli
41+
$ octadist_cli
4542

46-
Requirements
47-
============
43+
# Requirements
4844

49-
- Python 3.7, 3.8, 3.9
50-
- numpy
51-
- matplotlib
52-
- sciPy
53-
- rmsd
54-
- plotly
55-
- pymatgen <= 2021.3.3
45+
- Python 3.7, 3.8, 3.9
46+
- numpy
47+
- matplotlib
48+
- sciPy
49+
- rmsd
50+
- plotly
51+
- pymatgen <= 2021.3.3
5652

5753
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
5854

59-
If you have any problem, please submit your issues on OctaDist Github.
55+
If you have any problem, please submit your issues on OctaDist Github.
6056
https://github.com/OctaDist/OctaDist
6157

6258
Rangsiman Ketkaew (ETH Zurich, Switzerland)

compile.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/bash
22

3-
# OctaDist Copyright (C) 2019-2024 Rangsiman Ketkaew et al.
3+
# OctaDist Copyright (C) 2019-2026 Rangsiman Ketkaew et al.
44
#
55
# This program is free software: you can redistribute it and/or modify
66
# it under the terms of the GNU General Public License as published by

docs/conf.py

Lines changed: 48 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import sys
1717
import sphinx_rtd_theme
1818

19-
sys.path.insert(0, os.path.abspath('./../...'))
19+
sys.path.insert(0, os.path.abspath("./../..."))
2020
# sys.path.insert(0, os.path.abspath('.'))
2121
# sys.path.insert(0, os.path.abspath('../src'))
2222

@@ -26,23 +26,23 @@
2626

2727
# -- Project information -----------------------------------------------------
2828

29-
project = 'OctaDist'
30-
copyright = '2019-2024, Rangsiman Ketkaew et al.'
31-
author = 'Rangsiman Ketkaew'
29+
project = "OctaDist"
30+
copyright = "2019-2026, Rangsiman Ketkaew et al."
31+
author = "Rangsiman Ketkaew"
3232

3333
# The short X.Y version
34-
version = '3.1.0'
34+
version = "3.1.0"
3535
# The full version, including alpha/beta/rc tags
36-
release = '3.1.0'
36+
release = "3.1.0"
3737

3838
# Not alphabetically order
39-
autodoc_member_order = 'bysource'
39+
autodoc_member_order = "bysource"
4040
# autodoc_mock_imports = ['tkinter']
4141
autodoc_mock_imports = [
42-
# "octadist",
43-
"TkAgg",
44-
"pymatgen"
45-
]
42+
# "octadist",
43+
"TkAgg",
44+
"pymatgen",
45+
]
4646

4747
# -- General configuration ---------------------------------------------------
4848

@@ -54,13 +54,13 @@
5454
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
5555
# ones.
5656
extensions = [
57-
'sphinx.ext.autodoc',
58-
'sphinx.ext.intersphinx',
59-
'sphinx.ext.mathjax',
60-
'sphinx.ext.viewcode',
61-
'sphinx.ext.githubpages',
62-
'sphinx.ext.napoleon',
63-
'sphinx_rtd_theme',
57+
"sphinx.ext.autodoc",
58+
"sphinx.ext.intersphinx",
59+
"sphinx.ext.mathjax",
60+
"sphinx.ext.viewcode",
61+
"sphinx.ext.githubpages",
62+
"sphinx.ext.napoleon",
63+
"sphinx_rtd_theme",
6464
]
6565

6666
# import numpydoc
@@ -85,24 +85,24 @@
8585
napoleon_use_rtype = False
8686

8787
# Add any paths that contain templates here, relative to this directory.
88-
templates_path = ['_templates']
88+
templates_path = ["_templates"]
8989

9090
# The suffix(es) of source filenames.
9191
# You can specify multiple suffix as a list of string:
9292
#
9393
# source_suffix = ['.rst', '.md']
94-
source_suffix = '.rst'
94+
source_suffix = ".rst"
9595

9696
# The master toctree document.
97-
master_doc = 'index'
97+
master_doc = "index"
9898

9999
# List of patterns, relative to source directory, that match files and
100100
# directories to ignore when looking for source files.
101101
# This pattern also affects html_static_path and html_extra_path.
102-
exclude_patterns = ['_build']
102+
exclude_patterns = ["_build"]
103103

104104
# The name of the Pygments (syntax highlighting) style to use.
105-
pygments_style = 'sphinx'
105+
pygments_style = "sphinx"
106106

107107
todo_include_todos = False
108108

@@ -111,12 +111,12 @@
111111
# The theme to use for HTML and HTML Help pages. See the documentation for
112112
# a list of builtin themes.
113113
#
114-
html_theme = 'sphinx_rtd_theme'
114+
html_theme = "sphinx_rtd_theme"
115115
# html_theme = 'default'
116116
# html_theme = 'alabaster'
117117

118118
# Theme options are theme-specific and customize the look and feel of a theme
119-
html_theme_path = ['.']
119+
html_theme_path = ["."]
120120

121121
# Theme options
122122
# further. For a list of options available for each theme, see the
@@ -126,8 +126,8 @@
126126
# 'typekit_id': 'hiw1hhg',
127127
# 'analytics_id': '',
128128
# 'sticky_navigation': True # Set to False to disable the sticky nav while scrolling.
129-
'logo_only': True, # if we have a html_logo below, this shows /only/ the logo with no title text
130-
'collapse_navigation': False, # Collapse navigation (False makes it tree-like)
129+
"logo_only": True, # if we have a html_logo below, this shows /only/ the logo with no title text
130+
"collapse_navigation": False, # Collapse navigation (False makes it tree-like)
131131
# 'display_version': True, # Display the docs version
132132
# 'navigation_depth': 4, # Depth of the headers shown in the navigation bar
133133
}
@@ -141,7 +141,7 @@
141141
"conf_py_path": "/", # Path in the checkout to the docs root
142142
}
143143

144-
html_logo = '../images/molecule.png'
144+
html_logo = "../images/molecule.png"
145145

146146
# Add any paths that contain custom static files (such as style sheets) here,
147147
# relative to this directory. They are copied after the builtin static files,
@@ -162,57 +162,61 @@
162162
# -- Options for HTMLHelp output ---------------------------------------------
163163

164164
# Output file base name for HTML help builder.
165-
htmlhelp_basename = 'OctaDistdoc'
165+
htmlhelp_basename = "OctaDistdoc"
166166

167167
# -- Options for LaTeX output ------------------------------------------------
168168

169169
latex_elements = {
170170
# The paper size ('letterpaper' or 'a4paper').
171171
#
172172
# 'papersize': 'letterpaper',
173-
174173
# The font size ('10pt', '11pt' or '12pt').
175174
#
176175
# 'pointsize': '10pt',
177-
178176
# Additional stuff for the LaTeX preamble.
179177
#
180178
# 'preamble': '',
181-
182179
# Latex figure (float) alignment
183180
#
184181
# 'figure_align': 'htbp',
185-
186182
# Avoid blank pages in generated PDF file
187-
'extraclassoptions': 'openany,oneside'
183+
"extraclassoptions": "openany,oneside"
188184
}
189185

190186
# Grouping the document tree into LaTeX files. List of tuples
191187
# (source start file, target name, title,
192188
# author, documentclass [howto, manual, or own class]).
193189
latex_documents = [
194-
(master_doc, 'OctaDist.tex', 'OctaDist Documentation',
195-
'OctaDist Development Team', 'manual'),
190+
(
191+
master_doc,
192+
"OctaDist.tex",
193+
"OctaDist Documentation",
194+
"OctaDist Development Team",
195+
"manual",
196+
),
196197
]
197198

198199
# -- Options for manual page output ------------------------------------------
199200

200201
# One entry per manual page. List of tuples
201202
# (source start file, name, description, authors, manual section).
202-
man_pages = [
203-
(master_doc, 'octadist', 'OctaDist Documentation',
204-
[author], 1)
205-
]
203+
man_pages = [(master_doc, "octadist", "OctaDist Documentation", [author], 1)]
206204

207205
# -- Options for Texinfo output ----------------------------------------------
208206

209207
# Grouping the document tree into Texinfo files. List of tuples
210208
# (source start file, target name, title, author,
211209
# dir menu entry, description, category)
212210
texinfo_documents = [
213-
(master_doc, 'OctaDist', 'OctaDist Documentation',
214-
author, 'OctaDist', 'One line description of project.',
215-
'Miscellaneous'),
211+
(
212+
master_doc,
213+
"OctaDist",
214+
"OctaDist Documentation",
215+
author,
216+
"OctaDist",
217+
"One line description of project.",
218+
"Miscellaneous",
219+
),
216220
]
217221

218222
# -- Options for Epub output -------------------------------------------------
@@ -230,7 +234,7 @@
230234
# epub_uid = ''
231235

232236
# A list of files that should not be packed into the epub file.
233-
epub_exclude_files = ['search.html']
237+
epub_exclude_files = ["search.html"]
234238

235239
# -- Extension configuration -------------------------------------------------
236240

docs/license.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
License
33
=======
44

5-
OctaDist Copyright (C) 2019-2024 Rangsiman Ketkaew et al.
5+
OctaDist Copyright (C) 2019-2026 Rangsiman Ketkaew et al.
66

77
This program is free software: you can redistribute it and/or modify
88
it under the terms of the GNU General Public License as published by

octadist/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# OctaDist Copyright (C) 2019-2024 Rangsiman Ketkaew et al.
1+
# OctaDist Copyright (C) 2019-2026 Rangsiman Ketkaew et al.
22
#
33
# This program is free software: you can redistribute it and/or modify
44
# it under the terms of the GNU General Public License as published by
@@ -30,7 +30,7 @@
3030
"Philippe Guionneau, Mathieu Marchivie, David J. Harding"
3131
)
3232
__maintainer__ = "Rangsiman Ketkaew"
33-
__copyright__ = "OctaDist Copyright (C) 2019-2024 Rangsiman Ketkaew et al."
33+
__copyright__ = "OctaDist Copyright (C) 2019-2026 Rangsiman Ketkaew et al."
3434
__license__ = "GNU v3"
3535
__credit__ = "OctaDist Development Team"
3636
__email__ = "rangsiman1993@gmail.com"

octadist/__main__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/env python
22

3-
# OctaDist Copyright (C) 2019-2024 Rangsiman Ketkaew et al.
3+
# OctaDist Copyright (C) 2019-2026 Rangsiman Ketkaew et al.
44
#
55
# This program is free software: you can redistribute it and/or modify
66
# it under the terms of the GNU General Public License as published by

octadist/logo/Icon_Base64.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# OctaDist Copyright (C) 2019-2024 Rangsiman Ketkaew et al.
1+
# OctaDist Copyright (C) 2019-2026 Rangsiman Ketkaew et al.
22
#
33
# This program is free software: you can redistribute it and/or modify
44
# it under the terms of the GNU General Public License as published by

octadist/logo/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# OctaDist Copyright (C) 2019-2024 Rangsiman Ketkaew et al.
1+
# OctaDist Copyright (C) 2019-2026 Rangsiman Ketkaew et al.
22
#
33
# This program is free software: you can redistribute it and/or modify
44
# it under the terms of the GNU General Public License as published by

octadist/main.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# OctaDist Copyright (C) 2019-2024 Rangsiman Ketkaew et al.
1+
# OctaDist Copyright (C) 2019-2026 Rangsiman Ketkaew et al.
22
#
33
# This program is free software: you can redistribute it and/or modify
44
# it under the terms of the GNU General Public License as published by
@@ -1738,7 +1738,7 @@ def show_license():
17381738
17391739
"""
17401740
text = """\
1741-
OctaDist Copyright (C) 2019-2024 Rangsiman Ketkaew et al.
1741+
OctaDist Copyright (C) 2019-2026 Rangsiman Ketkaew et al.
17421742
17431743
This program is free software: you can redistribute it and/or modify \
17441744
it under the terms of the GNU General Public License as published by \

0 commit comments

Comments
 (0)