Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added cjson.py which can be used to read cjson #1360

Merged
merged 7 commits into from
Oct 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 155 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,156 @@
docs/build
.DS_Store
.DS_Store
.vscode
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/
79 changes: 79 additions & 0 deletions python/avogadro/cjson.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
"""
/******************************************************************************
This source file is part of the Avogadro project.
This source code is released under the New BSD License, (the "License").
******************************************************************************/
"""
import json
ghutchis marked this conversation as resolved.
Show resolved Hide resolved
class Cjson:
"""
This Class is intended to read Cjson files
with python libraries and perform certain
methods on files and convert them back to Cjson
files as required
"""
def __init__(self):
pass
def __from_cjson(self, filePath):
'''Use to read CJson formats by converting them to python dictionaries'''
with open(filePath, 'r') as cjsonFile:
py_dict_data = json.load(cjsonFile)
return py_dict_data
def __to_cjson(self, cjson_dict_file):
'''It converts python dictionaries to CJson format'''
cjsonData = json.dumps(cjson_dict_file, indent=4)
return (cjsonData)
def get_atoms_coords(self,filePath):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we want both a method to get an array of coordinates and set the data["atoms"]["coords"]["3d"] from an array of (-1, 3) coordinates.

If you want to add this method (which returns coordinates + atomic number), I'd want to also see:

  • get_atoms_coordinates() - this method
  • set_atoms_coordinates() - setting the data[] from an array of coordinates and elements
  • get_elements() - simply returning the elements from data["atoms"]["elements"]["number"]
  • set_elements() - setting the elements
  • get_coordinates() - just return the coordinates
  • set_coordinates() - just set the coordinates

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I will add all these functions shortly.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ghutchis can you please help me with the format for input array of coordinates and elements for set_atoms_coordinates.

"""
It helps to get the co-ordinates of individual elements/atoms in the format
[
x co-ordinate
y co-ordinate
z co-ordinate
Atomic Number of Element
]
"""
data = self.__from_cjson(filePath)
coords = data["atoms"]["coords"]["3d"]
elements = data["atoms"]["elements"]["number"]
element_coords = [(*coords[i*3:(i+1)*3], elements[i]) for i in range(0, int(len(coords) / 3))]
cjson_dict = {"element-coordinates" :element_coords}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why? Shouldn't you just return the element_coords array?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok! I got this, actually we can return the array too, but earlier in the you told (#712 (comment) point 2) to return the cjson so I have to make it into dictionary element as Cjson interconversion is python dictionaries.

I have a idea that I should return the array and make private to_cjson() fun public which would take array or list as input and convert it into cjson

return self.__to_cjson(cjson_dict)
def get_elements(self, filePath):
'''
returns all the elements present in cjson file
'''
data = self.__from_cjson(filePath)
elements = data["atoms"]["elements"]["number"]
return elements
def get_coordinates(self,filePath):
'''
returns the coordinate array
'''
data = self.__from_cjson(filePath)
coords = data["atoms"]["coords"]["3d"]
return coords
def set_atoms_coordinates(self, filePath, coords_array):
'''
it updates the coordinates array in cjson file
'''
data = self.__from_cjson(filePath)
data["atoms"]["coords"]["3d"] = coords_array
return self.__to_cjson(data)
def set_elements(self, filePath, elements_array):
'''
It sets all the elements present in the cjson file
where elements are set/recognized by their atomic numbers
'''
data = self.__from_cjson(filePath)
data["atoms"]["elements"]["number"] = elements_array
return self.__to_cjson(data)
def set_coordinates(self, filePath, coords_array):
'''
It helps to set all coordinates of the
cjson file where coordinates of all elements
can be changed by an input array of coords_array
'''
data = self.__from_cjson(filePath)
data["atoms"]["coords"]["3d"] = coords_array
return self.__to_cjson(data)
Loading