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

Update templates #84

Merged
merged 36 commits into from
Mar 5, 2024
Merged

Update templates #84

merged 36 commits into from
Mar 5, 2024

Conversation

mcflugen
Copy link
Member

@mcflugen mcflugen commented Nov 30, 2022

This pull request updates the templates used by the babelizer to generate projects of wrapped BMI components.

Most of the changes are in the generated documentation:

  • docs use the furo theme
  • the babelizer generates csdms-styled logos (dark and light themed) for the new project
  • fleshed out the documentation to include installation, usage, virtual environments, API, and how to update the project with the babelizer

I've also added a nox file and a pre-commit hooks file for running routine maintenance tasks (building the docs, checking for lint, etc.).

I've set up towncrier in the generated project as well. This may be overkill but since we consider it good practice elsewhere I figured we could try it here as well.

I removed the recipe folder that held the generated conda recipe since we don't use that anymore.

@mcflugen mcflugen requested a review from mdpiper December 2, 2022 21:36
@mcflugen
Copy link
Member Author

mcflugen commented Dec 2, 2022

One more thing. I removed the setuptools version requirement for the build system. I had required setuptools<60 because of a problem building Fortran projects (numpy doesn't not support newer version of setuptools) but older versions of setuptools don't support pyproject.toml files. Anyway, it appears that perhaps numpy fixed the issue since we're no longer seeing those fortran build errors we had been getting.

Comment on lines +71 to +81
.. tab:: mamba

.. code:: bash

mamba install {{ cookiecutter.package_name }}

.. tab:: conda

.. code:: bash

conda install {{ cookiecutter.package_name }}
Copy link
Member

Choose a reason for hiding this comment

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

Should -c conda-forge be explicitly added to these install instructions? I can't remember if we have instructions to add conda-forge as a default channel elsewhere.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not certain. mamba may use the conda-forge channel be default but I don't think conda does. I guess we should double check and possibly add the -c conda-forge option to these commands.

@mcflugen mcflugen merged commit 20fff37 into develop Mar 5, 2024
30 of 36 checks passed
@mcflugen mcflugen deleted the mcflugen/update-templates branch March 5, 2024 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants