alexanderibrahim1/cartesian

A collection of classes and functions to express points in continuous 1D, 2D, and 3D space.

cartesian's Issues

Clean up the tests directory

There is a lot of boilerplate and repetition in the tests/test_point.py file.

This is because it was my first time seriously using pytest. I should get better at using pytest and clean up the code.

A good starting point would be to read about test fixtures.

Make .coordinates() into a property

Add size property

Add a property/method to get the size of the point so I can stop using len(point._coords)

Change setup.cfg and pyproject.toml to accommodate the new development dependencies

For setup.cfg

• include the minimum requirements from requirements_dev.txt
• indicate that typing is used
• set flake8 max-line-length to 160 (just copy mCoding's example for now)

For pyproject.toml

• fill in fields for tool.pytest.ini_options
• fill in fields for tool.mypy

Until I know better, copy the fields directly from the pyproject.toml of mCoding's example repo

• it uses an MIT license

Clean up the implementations for Cartesian1D, Cartesian2D, Cartesian3D

I learned more about abstract classes and the super() constructor.
I can remove a lot of code from the implementations of Cartesian{1D, 2D, 3D},
and put them into the implementation of CartesianND.

Add black, flake8, pytest, and mypy

This means adding a requirements_dev.txt file.

Turn the project into a Python package

Add a setup.cfg and pyproject.toml.
There are no dependencies, so no requirements.txt file is needed.

Implement addition, subtraction, and scaling of the cartesian points

Should be generic with respect to dimension.
Write tests for it too.

Fix all the current flake8 and mypy issues

The existing files don't pass the linters.

Implement feature to take distance between two points

I want to be able to calculate the distance between two Cartesian points.

Create a separate file containing different measures of distance.

• distance between two points in free space
• distance between two points in a periodic box

Implement functions to take the norm of a point.

Implement the ability to calculate the distance or the distance squared.

Implement division by scalars

I implemented addition, subtraction, and multiplication, but I forgot about division.