Add Logo

[FrederikSchnack]

Hi Team! In this PR we want to fix #534.

todos:

• survey which logo to use
• absolute path in the readme for the logo, such that it shows up in the documentation. This is done, so the preview on the logo branch is broken.

Q:

• codacy doesn't like adding a new requirement

In the following I will present the four possible logos that are available. Please react with a ❤️ emoji for the one you like the most. If there is any concrete feedback, please let me know.

Commit Summary

Add logo for README and documentation. Fixes #534.

• Add docs/logo/ folder with three SVG images:
  • psydac_platypus.svg with the PSYDAC platypus logo
  • psydac_banner.svg with a long banner (text + logo) for the README
  • psydac_square.svg with a compact square banner (text + logo) for use in presentations with a white background
• Include contents of README.md in generated documentation
• Use absolute paths in README.md for correct linking
• Add myst-parser to documentation requirements
• Fix instructions in "Building the Docs" section
• Remove useless links from bottom of main page in documentation (already present on the top)
• Add square PSYDAC logo to header in documentation page
• Improve layout of documentation page

[FrederikSchnack]

[FrederikSchnack]

[FrederikSchnack]

[FrederikSchnack]

[campospinto]

I prefer this logo but I'm not convinced by the text font... I think I would prefer smoother fonts, like this one or that one ... Yaman also had another idea for the text

[FrederikSchnack]

I prefer this logo but I'm not convinced by the text font... I think I would prefer smoother fonts, like this one or that one ... Yaman also had another idea for the text

Should we vote on the kind of banner first, lets say until tomorrow evening, then I can provide a few different (proposed) fonts and we conclude the survey in the meeting this week?

[kvrigor]

As much as I like the logo, I'm worried this could be a cause for copyright infringement: https://pokemon.gamespress.com/Media-Usage-Guidelines

I'm no legal expert, but perhaps somebody with legal expertise can be consulted?

Or perhaps a poorer FE approximation could generate a safer logo (honestly I don't know 😅)? If it weren't for copyright doubts the logo already works

[FrederikSchnack]

Hear me out, what do you think of a (duck-billed) platypus?
I feel like it has the same spirit, the duck wordplay is apparent and its more exciting than an ordinary duck :D

This is a quick version, that can be refined if liked...

[EmilyBourne]

Hear me out, what do you think of a (duck-billed) platypus?
I feel like it has the same spirit, the duck wordplay is apparent and its more exciting than an ordinary duck :D

This is a quick version, that can be refined if liked...

Good idea! I think you need to move the arms though. It looks like he's got long dog ears

[FrederikSchnack]

Hear me out, what do you think of a (duck-billed) platypus?
I feel like it has the same spirit, the duck wordplay is apparent and its more exciting than an ordinary duck :D

This is a quick version, that can be refined if liked...

Good idea! I think you need to move the arms though. It looks like he's got long dog ears

oh noo, now I can't unsee it 🙈

[FrederikSchnack]

I just added a first platypus version. Let me know what you think with the colors, limbs etc.

[FrederikSchnack]

@yguclu I took the liberty to work on the cube font, what do you think? We can change the colors very easily.

[jowezarek]

@yguclu I took the liberty to work on the cube font, what do you think? We can change the colors very easily.

I think it's great!

[yguclu]

@yguclu I took the liberty to work on the cube font, what do you think? We can change the colors very easily.

I think it's great!

I also think that's great! I was going to upload my SVG file, but I think yours looks better! As for the colors, how does that look if you swap yellow and blue?

[FrederikSchnack]

@yguclu I took the liberty to work on the cube font, what do you think? We can change the colors very easily.

I think it's great!

I also think that's great! I was going to upload my SVG file, but I think yours looks better! As for the colors, how does that look if you swap yellow and blue?

(Edit: With only one blue tone in the text it looks even better imo)

[FrederikSchnack]

@max-models If I have not misunderstood the discussion at our weekly meeting, the logo would consist of just the duck/platypus. The word "PSYDAC" is for the banner on top of the README

I think that's what we said, but if people look for logos to put in their presentations, they probably take the first one they can find, which is the repo banner.

[FrederikSchnack]

I agree that the cube font is hard to read, especially on a white background. I now added:

• a psydac platypus banner with cube font
• a psydac platypus alternative banner with the font Martin proposed
• a psydac platypus square logo
• the psydac platypus

They can be found here: https://github.com/pyccel/psydac/tree/logo/docs/source/logo.

[FrederikSchnack]

This is what the documentation looks like with the current setup:

[max-models]

I agree that the cube font is hard to read, especially on a white background. I now added:

• a psydac platypus banner with cube font
• a psydac platypus alternative banner with the font Martin proposed
• a psydac platypus square logo
• the psydac platypus

They can be found here: https://github.com/pyccel/psydac/tree/logo/docs/source/logo.

Great!

[yguclu]

I agree that the cube font is hard to read, especially on a white background. I now added:

• a psydac platypus banner with cube font

• a psydac platypus alternative banner with the font Martin proposed

• a psydac platypus square logo

• the psydac platypus

They can be found here: https://github.com/pyccel/psydac/tree/logo/docs/source/logo.

Maybe because I always use the dark theme on GitHub, I have not considered the cube logo to have any visibility issues.. A yellow banner over a white background is probably not ideal 😅

[campospinto]

Thanks Frederik! I think this logo and the associated banner look very nice.

[yguclu]

Thanks Frederik! I think this logo and the associated banner look very nice.

And by "this logo" you mean which version? 😜 I have gotten lost a bit

[campospinto]

Thanks Frederik! I think this logo and the associated banner look very nice.

And by "this logo" you mean which version? 😜 I have gotten lost a bit

the one that is on the readme (in the current version of this branch). If I'm not mistaken it corresponds to #540 (comment)

[campospinto]

Thanks Frederik! I think this logo and the associated banner look very nice.

And by "this logo" you mean which version? 😜 I have gotten lost a bit

the one that is on the readme (in the current version of this branch). If I'm not mistaken it corresponds to #540 (comment)

[yguclu]

Thanks a lot for this PR!

I will have a look at the generated docs and get back to you ASAP

[yguclu]

I suppose the banner will show up in the docs once we have merged the PR?

[FrederikSchnack]

I suppose the banner will show up in the docs once we have merged the PR?

Yes exactly, but you can check the artifacts from two commits ago. I had to put the absolute path of the banner file in the README as otherwise it will not show up in the documentation. And in order for it to work after the merge, I had to put the path it will have on the devel branch.

[yguclu]

Looks good to me!

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.00%	∅

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (b68b7eb)	31852	19688	61.81%
Head commit (3897bc0)	63704 (+31852)	39374 (+19686)	61.81% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#540)	0	0	∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences