Use this to write down notes and follow the progress of the project. This will be particularly useful for updating the HISTORY.rst file before releases.
First, generate an API token for your account or project at https://pypi.org/manage/account/token/
Then, use this token when publishing instead of your username and password.
See https://pypi.org/help/#apitoken for help using API tokens to publish.
- 2022-07-30 Tried to use GitHub actions for windows tests - failed most likely due to missing AccessDatabaseEngine.
- 2022-07-30 Changed from pip to conda install (dev_environment.yml) in Appveyor - fixed failed run!
- ?
Note: misspelling in the branch title.
Status: Mohammad might be working on it?
Status: Finished!
Status: Implemented - but missing documentation.
https://realpython.com/factory-method-python/
Status: Implemented - but missing documentation.
Status: implemented - but missing documentation
Status: implemented - but missing documentation
Made new repository (cellpy_cookies) Populated with two templates (standard and ife) Checked and updated standard template, but needs more tweaking (functioning, though) Not checked and updated code in ife template(TODO)
Fixed
Steps:
- clean up b.update (in progress) [x] implement cellpy.loadcell into cellpy.get [x] implement cellpy.loadcell into cellpy.get
- clean up simple db reader (or whatever it is called inside journal etc) (in progress)
- clean up dbreader (in progress)
- implement/test using an ORM (SQAlchemy?) (in progress)
-
Added a subclass of pathlib.Path that can be used to access files on a remote server using ssh.
-
Added new methods to the base loader and implemented new restrictions/requirements on the loaders.
- all .loader methods must now start with assigning self.name and running self.copy_to_temporary() to copy the file to a local temporary
- fid is generated through running self.generate_fid() and fid is added to the Data instances using self.fid as argument.
-
Modify AtomicLoad in base.py so that it can handle the new Path subclass and use it to load files from a remote server.
- After some trail and errors, the next step now will be to implement the actual ssh connection and file transfer in core.copy_external_file
-
Implement the ssh connection and file transfer in core.copy_external_file
- This will be done by using the paramiko library.
- The connection will be established in core.copy_external_file and the file will be copied to a temporary directory on the local machine.
- The temporary directory will be deleted after the file has been copied.
- Test is in test_cell_reader.py (test_copy_external_file) copied as txt in local/notes.md
-
Update filefinder and prms to handle the new Path subclass.
-
Check if loaders can be updated to automatically run the new methods in the base loader (self.name and self.copy_to_temporary()).
-
Update dependencies (setup.py, requirements.txt etc)
Add token to .env (for uploading to PyPI)
Package 'cellpy.utils.data' is absent from the packages configuration.
Package 'cellpy.utils.data.raw' is absent from the packages configuration
Could be an error in the cycle_mode handling in get(). Need to check this. Also, need to make sure that cellpy handles the specifics correctly (gravimetric, areal, etc). Update: Did not work for areal for John.
- Implemented nom_cap_specifics and conversion of units wrt input.
- Added automatic conversion of units if giving mass, area, or nominal capacity as strings with units (e.g. "0.1 mg", "12 cm2", "100.2 mAh"). Damned! It seems that updating the nom_cap_specifics in the cellpyfile does not work properly yet. It still said gravimetric for the one that should be areal!!!!!!!!!!!!!! NEED TO FIX THIS ASAP!!!!!!!!!!!!!!!!!!!!!
https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#sections
All of the following section headers are supported:
-
Args (alias of Parameters)
-
Arguments (alias of Parameters)
-
Attention
-
Attributes
-
Caution
-
Danger
-
Error
-
Example
-
Examples
-
Hint
-
Important
-
Keyword Args (alias of Keyword Arguments)
-
Keyword Arguments
-
Methods
-
Note
-
Notes
-
Other Parameters
-
Parameters
-
Return (alias of Returns)
-
Returns
-
Raise (alias of Raises)
-
Raises
-
References
-
See Also
-
Tip
-
Todo
-
Warning
-
Warnings (alias of Warning)
-
Warn (alias of Warns)
-
Warns
-
Yield (alias of Yields)
-
Yields
Additional sections implemented by cellpy:
-
Transferred Parameters
-
See Also
Add a list of custom sections to include, expanding the list of parsed sections. Defaults to None.
The entries can either be strings or tuples, depending on the intention:
-
To create a custom “generic” section, just pass a string.
-
To create an alias for an existing section, pass a tuple containing the alias name and the original, in that order.
-
To create a custom section that displays like the parameters or returns section, pass a tuple containing the custom section name and a string value, “params_style” or “returns_style”.
If an entry is just a string, it is interpreted as a header for a generic section. If the entry is a tuple/list/indexed container, the first entry is the name of the section, the second is the section key to emulate. If the second entry value is “params_style” or “returns_style”, the custom section will be displayed like the parameters section or returns section.